软件文档笔记

软件文档

文档规范的意义和管理方法

分类和等级
必要性
从项目管理的依据，工作交流的凭证，软件测试的基础，培训用户的参考，技术支持的帮手，记录历史的必须。
编写的基本思路
明确文档规范
避免空泛乏味
定位读者角度
防止对牛弹琴
规范名词称为
保持前后一致
注意版本控制
切记顾此失彼
应用图文表格
保证内容清晰
软件开发过程=规范文档生成的过程

文档分类

一条线：设计开发类
可行性研究报告
项目开发计划书
需求规格说明书
功能规格说明书
概要设计说明书
详细设计说明书
数据库设计说明书
模块开发卷宗
测试计划
管理类
开发进度月报
项目开发总结
职责定义
进度变更记录
测试分析报告
产品类
用户指南
操作指南
信息报告
另一条线
可行性研究计划阶段
数据需求说明书
项目开发计划
开发进度月报
设计阶段
概要设计说明书
详细计划说明书
测试计划
文档等级
确定文档质量等级
按质量划分四个等级
最低限度文档1级
内部文档2级
工作文档3级
正式文档4级

文档管理的原则和方法

原则
完整性原则，简介性原则，有效性原则，延续性原则，
文档管理内容
建规范，定计划，提效率，护产权，记历史。
文档管理方法
命名的重要性和规则制定
命名重要性
规则制定
同一封面和项目名称
设定类型多文档命名方法
规定文档存储和管理方法
如何保证内容的完整（内容残缺的体现，保证内容的完整性）
如何写好需求分析（做好需求分析的前提条件（对客户应用环境的了解，对市场以及对技术主流了解以及客户需求的总结和潜在需求的挖掘））
完成需求分析过程：项目建议书，市场和技术调研报告，需求变更风险分析，需求分析初稿
如何写号概要计划
做好概要设计前提条件：
了解客户需求细节，分析技术重难点，设计划分系统结构
完成概要设计过程：
功能描述
功能定义
重难点问题解决思路
拟定概要设计草案
如何写好详细设计
底层
处理流程

对外借口以及逻辑结构和数据结构的详细说明

如何写好历程杯报告
内容
预期目标的解释说明，已完成工作说明，进度情况，测试结果分析说明以及下一步工作难点
过程：
分析前历程碑报告，说明当前文件的主要进展，总结存在问题，列出下一步工作计划。
确定文档最小级
如何做：最重要，最必须的文档集合
如何实现最小集：人员分工，统一模板，合并细节保持完整.