文档介绍：软件工程管理中的文档撰写
技术支持组
软件工程管理文档的概述
文档撰写规范及要求
文档撰写存在的问题
主
要
内
容
精品资料
你怎么称呼老师？
如果老师最后没有总结一节课的重点的难点，你是否会认为老师的教学方法需要改进？
你所经历的课堂，是讲座式还是讨论式？
教师的教鞭
“不怕太阳晒，也不怕那风雨狂，只怕先生骂我笨，没有学问无颜见爹娘 ……”
“太阳当空照，花儿对我笑，小鸟说早早早……”
选择机会
识别项目
项目建议书
立项
可行性研究
项目论证
项目许可
项目规划
项目实施
项目验收
项目收尾
项目后评估
文档撰写伴随软件项目全生命周期
立项
软件工程中文档撰写的目的与意义
意见收集与反馈、经验总结
进度及质量管理、客户沟通
项目成功的需要
个人成长
…
领导支持
团队建设
客户沟通
为什么要文档化
开发人员通过文档化的过程查错补遗；
便于评审，在早期发现技术上的问题；
后续阶段开发任务可能由他人承担，输出文档便于他们开展工作；
维护人员开展维护工作需要；
文档是必要的交付件；
…………
文档是软件开发企业的重要财富，可读性尤为关键
产品类文档
需求分析
功能设计
架构设计
数据库设计
界面设计
概要设计
详细设计
软件开发的文档分类
可行性分析
产品简介
产品演示
功能介绍
测试报告
安装手册
用户使用手册
维护手册
培训资料
管理类文档
开发计划
进度报告
问题答复
项目总结
…开发类文档
文档撰写水平代表思考问题的能力
文档撰写能力已经成为软件工程师
尤其是项目管理人员的一项基本技能
文档撰写规范化是软件工程管理规范化的起点
文档撰写规范化是项目管理的重要手段…
文档撰写规范化是市场营销的最佳途径…
目前项目组文档撰写的现状
偏重项目成果
忽视文档输出
文档管理混乱
管理者要求不到位
用户要求不明确
自身要求不到位
视文档为负担
要求不到位
文档撰写不规范
缺乏考核机制
不愿写
不会写
没时间写
草草数言应付了事
艰深复杂难以理解
格式错误逻辑不清
没有软件文档
文档质量不合格
文档与项目错位
文档更新不及时文档管理混乱