个人的开发文档编写思路【不断更新

By | 2019年1月22日

文档编写思路:
“功能点”驱动——将层次分块,内部结构 / 功能逐层细分,对每一层进行相应的描述。

层次分块:
 一、各模块(宏观可见的大功能)说明;
 二、模块内各部分说明;
 三、类说明(概述);
 四、函数说明(参数、返回值 / 执行效果);

文档中各处都可以添加技术重点、难点、存在的问题等

各层次中需添加的描述:
1. 增加的 / 被修改的类的说明
 a. 功能概述;
 b. 调试用输出信息说明;
2. 接口说明
 a. 参数的类型、名称;
 b. 返回值说明;
 c. 其他附加说明。
3. 进行修改的位置
 文件相对位置、行数、注释标记(规则);
4. 被修改部分与其他部分的耦合情况;

在实际开发时,要随时向开发计划文档中追加详细说明(如类和函数的名称等)

点击量:337

发表评论

邮箱地址不会被公开。 必填项已用*标注