搜索
软件工程管理中的文档撰写技术支持组软件工程管理文档的概述文档撰写规范及要求文档撰写存在的问题主要内容选择机会识别项目项目建议书立项可行性研究项目论证项目许可项目规划项目实施项目验收项目收尾项目后评估文档撰写伴随软件项目全生命周期立项软件工程中文档撰写的目的与意义意见收集与反馈、经验总结进度及质量管理、客户沟通项目成功的需要个人成长…领导支持团队建设客户沟通为什么要文档化开发人员通过文档化的过程查错补遗；便于评审，在早期发现技术上的问题；后续阶段开发任务可能由他人承担，输出文档便于他们开展工作；维护人员开展维护工作需要；文档是必要的交付件；…………文档是软件开发企业的重要财富，可读性尤为关键产品类文档–需求分析–功能设计–架构设计–数据库设计–界面设计–概要设计–详细设计软件开发的文档分类–可行性分析–产品简介–产品演示–功能介绍–测试报告–安装手册–用户使用手册–维护手册–培训资料管理类文档–开发计划–进度报告–问题答复–项目总结…开发类文档文档撰写水平代表思考问题的能力文档撰写能力已经成为软件工程师尤其是项目管理人员的一项基本技能–文档撰写规范化是软件工程管理规范化的起点–文档撰写规范化是项目管理的重要手段…–文档撰写规范化是市场营销的最佳途径…目前项目组文档撰写的现状•偏重项目成果•忽视文档输出•文档管理混乱•管理者要求不到位•用户要求不明确•自身要求不到位视文档为负担要求不到位文档撰写不规范缺乏考核机制•不愿写•不会写•没时间写•草草数言应付了事•艰深复杂难以理解•格式错误逻辑不清没有软件文档文档质量不合格文档与项目错位文档更新不及时文档管理混乱合格文档的几项标准优秀图标…–主题明确–内容完整–逻辑清晰–简洁直观文档主题明确的含义文档的阅读人是谁？他为什么需要阅读本文档？文档的撰写者需要达到什么目标？内容完整的含义逻辑清晰的含义报告中的文字与图表文档中图表的使用撰写文档前的准备工作需要做什么？如何做？何时完成（计划与目标）辅助资料准备齐全是否在按计划执行？如不是，原因何在？如何调整？下一步可能出现的问题与准备的措施？注意：表达观点时要简明扼要、用词准确。文档的主要内容报告情况：说明发生了什么、当前事情的状态解决方案：说明自己将如何处理事情；请求指示：请求得到上司的指示或指导。讨论：你在与上司沟通中碰到的最大难题是什么？你以往是怎样面对这些难题的？文档的八个基本要求（1）…针对性简洁性准确性易读性统一性完整性及时性正确性文档的八个基本要求（2）–…针对性–针对不同的对象有不同的写法–不要站在自己的立场上思考别人的问题–不要使用别人可能不理解的专业术语–对于陌生的术语要特别描述正确性–意思表达准确，没有二义性–标点符号正确使用，避免引起歧义准确性–材料使用完整–文档语句完整完整性–没有错字漏字–文档间引用关系正确–文档细节正确–观点表达正确文档的八个基本要求（3）–…简洁性–尽量避免使用过长的句子，无法避免时，正确使用标点符号–不要冗余，一个意思再文档中只表达一次–配以适当的图表，文字表达清晰统一性–文字描述通俗易懂–前后文关联恰当–文档更新内容与上一个版本区别开来易读性–事情发生后或者执行前提交文档–按照规定的时间提供文档及时性–统一使用专业术语和项目规定的术语集–同一个意思和术语，前后表达一致–文档字体同一–文档观点前后统一文档格式的要求应使用标准模板写作；文档封页、页眉页脚、修订记录、附录、参考文献应完善；关键词、摘要、缩略语应完整；目录要及时更新；通篇文档标题、文字格式、间距应协调美观；所有文档模板中的章节，只可增加，不可删除；编写建议是用来指导文档写作的，在利用完后要及时删除；图号置于图形之下，表号置于表格之上；文档中文字的要求应追求图文并茂的效果；句子和段落要短；使用语言应严谨，不要使用白话；采用主动语气；不要出现“我们”、“你们”、“他们”这样的称谓，或“这个”、“那个”这样的词，应使用“本××”、“该××”、“其”；表述清晰，避免引起歧义；通篇文档细节上要保持一致；文档管理的要求文档要及时发送给需要确认的人员文档的修改过程要规范文档要统一保存，及时维护文档要很方便地供使用者查阅文档要做好保密管理，对于无权查询的人要严格保密文档的保存要安全可靠优秀软件文档的特性（1）文档结构清晰。有基础坚实，并且层次明了才能让阅读者一目了然，架构清晰、主次分明才能让别人容易读懂文档要有明确的结论。文档分析的结论不要太多，要精简。分析结论一定要基于紧密严禁的数据分析推导过程，不要有猜测性的结论，如果一个结论连你自己都没有肯定的把握就不要拿出来误导别人了。好的分析要有很强的可读性优秀软件文档的特性（2）好的分析要有很强的可读性，要考虑你的分析阅读者是谁？他们最关心什么？你必须站在读者的角度去写文档。数据分析报告尽量图表化，用图表代替大量堆砌的数字会有助于人们更形象更直观地看清楚问题和结论，但是图表也不要太多，过多的图表一样会让人无所适从。好的分析报告一定要有逻辑性，通常要遵照：1、发现问题--2、总结问题原因--3、解决问题，逻辑性强的分析报告更容易让人接受优秀软件文档的特性（3）好的分析一定要基于可靠的数据源，在正确数据基础上做分析，才能找到正确的结论好的分析报告一定要有解决方案和建议方案。合理的建议和结论对工作更有意义，管理者不希望你只是个会发现问题的人。不要害怕或回避“不良结论”，分析就是为了发现问题，并为解决问题提供决策依据的，发现问题也是你的价值所在。不要创造太多难懂的名词，如果无可避免地要写一些名词，最好要有让人易懂的“名词解释附录1：软件各个阶段的文档---谢谢Thanks