软件工程管理中文档撰写[宣贯].pptVIP

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