| 火龙果软件工程技术中心
报名咨询热线： 北京 010-62670835 上海 021-50800371 深圳 15801587207
2010年11月26日，火龙果软件为国内某知名及领先的电信软件服务商提供了软件技术文档培训。
学员们的课前疑问与培训需求：
- 缺乏良好模板，文档模版要求太细，不实用，有时对于具体项目的细节又照顾不到；
- 文档格式不统一，每个人写文档风格不同，不易阅读；
- 技术人员写的文档思路不清晰，可读性差。对文档的理解有误，认为文档就是一种负担。
- 如何用文档指导开发工作；
- 开发项目怎样规划和安排文档编写，文档编写与开发工作怎样有效进行协作？
- 当需求不是很明确，外部需求或需求定位会频繁变动时文档编写怎样做？
- 各阶段文档应该何时开始编写、何时完成才能对项目本身起到更大的作用？
- 各阶段文档编写要求？
- 项目非常紧急情况下，又该如何做？是否对文档编写内容上可以有所删减，形式上放松要求？
- 如何避免文档编写过程中产生的枯燥感？如何能提高编写效率？
- 从我个人经验而言，公司已经有现成的项目文档模板，但是实际情况是各个项目组编写质量和重视程度普遍不够，这里面也有一些原因比如编写内容太多、进度要求紧、项目需求分析和设计过于表面等问题导致，所以我想通过此次培训重点关注上面一些问题的处理方法。
- 关于项目计划文档，很难写一份能够精确控制到整个项目周期的计划的文档，否则就会经常根据最新进度更新文档；一般是写一份总的只有里程碑时间的，再写一份project计划详细进度的，定期更新Project进度，请问是否还有其它方式
- 关于需求文档，除了业务功能需求之外的，其它系统需求或者要求写的比较少，如日志、安全性、性能等有没有参考样例
- 概要设计和详细设计的界定，对于一个复杂的系统，由多个子系统组成，那么系统总体有一个概要设计，每个子系统还应该有概要设计和详细设计，实际中我们是把后者合并了，只写了一个子系统的设计文档，请问针对这方面有无其它建议.
- 关于迭代项目，项目文档应该如何管理？文档升版本？每个迭代版本项目文档独立保存？
- 关于平台/系统类项目，是按照产品来管理(产品生命周期很长)，还是按照不同版本分项目来管理？按照项目来管理是否需要不同版本分配不同项目编号？
- 如何进行有效的文档的评审；
|
课程结合软件开发过程，讲解各个阶段的核心技术文档，对比好与差的文档，让学员了解问题及目标，并通过实际文档案例和结合项目发展讲解文档各个方面，课程注重实用与规范，拒绝流于形式。
学员一句话概括收益：
- 了解了常用开发文档的写作方法和容易出现的问题。
- 学习了规范的实际可行的技术文档编写和管理。
- 对需求的划分和业务需求编写这块有些新收获。
- 了解了需求文档的呈现方式；归纳方法的使用。
- 纠正自己平时写项目计划的误区，强化概要设计规范。
- 从业务需求到概要设计的文档编写要点。
- 了解开发文档重点和关注点。
- 如何写《业务需求说明书》和《系统需求说明书》。
- 理清了软件开发过程的文档编写过程，明确了文档编写的规范和方法。
- 对各种需求文档认识大幅加深。
- 对一些文档的规范和编写有所了解。知道自己的不足，明确以后改进的方向。
- 对UML图的认识，需求文档结构。
- 明确文档重要性，了解编写需求文档、项目计划、架构设计和详细设计文档的方向。
- 了解文档需要写的内容。
- 用例建模，会写需求文档了，重温软件工程。
- 更深理解文档的作用，对需求文档的分类更清晰。
- 业务需求与系统需求的区别。
- 不同文档间的侧重点，精简，准确。
- 能在设计阶段解决的问题最好在设计阶段解决。
- 开发前一定要先写好文档，而且是简洁明确的。
- 巩固了UML相关知识，加强了在写文档时使用UML的意识。
- 了解了各类文档大致功能规范。
- 学到了规范的文档内容组织方式
- 学到了编写各类文档的一般流程、结构。
- 对需求、总体设计文档比较明晰。
- 对软件过程的一些细节增加了了解。
- 师傅领进了门，修行在个人。
- 对需求文档的表述和归类有了深刻的理解。
- 文档变更的跟踪方式，不同视角的需求描述。
- 需求、计划、设计模板。
- 项目计划、界面原型的方法。
- 了解系统需求设计文档写法、系统计划、设计等文档写法
- 《业务需求说明书》和《系统需求说明书》。
- 需求分析文档、项目计划、架构设计文档编写方法。
- 对需求文档等写法有了更清晰的认识，组织图和UML这方面也是迫切需求的。
- 通过图形、表格的形式编写文档，加强文档的清晰度。
- 各文档编写结构，文档编写的流程和结构。
- 系统需求文档知识会用于工作，部分UML图示应用。
- UML相关图对于以后的设计文档编写很有帮助。
- 对业务需求、系统需求的文档的内容组织，以及uml图的学习，后续会加强学习、锻炼。
|
精彩回顾
本次课程内容包括：
- 软件开发涉及的技术文档
- 需求规格说明书文档编写
- 概要设计文档编写
- 详细设计文档编写
- 文档模板
- 文档的内容
- 文档编写案例
- 文档的质量要求
- 文档的质量标准
- 改进
- 等等
|
