如何编写项目文档

Question

我刚刚完成了一个相对较小的项目（在几个模块中约有3000行代码），并且我被要求为项目生成一个文档。我不知道该怎么做，因为我之前主要为其他程序员编写代码。我是否描述每个模块，为每个对象做UML图，简单地展开我的评论？有我可以使用的模板吗？如果有人不得不做标准文件，我会很感激你的帮助/指示。

Answer 1

“标准”文档没有多少内容; “Javadoc”风格的API文档与您近距离接近。获得更坚实的要求。您的客户需要什么类型的文档？所有类的UML图是一个整洁的练习，有时候很有用，但是你的时间可能会花在未来的项目上。

Answer 2

最起码你应该记录

• 如何构建软件
• 如何安装它
• 一个文件和工具的“明显”的要求
• 发行说明：从什么改变以前发布的版本
• 许可和版权信息

然后，根据软件的使用方式，您可能希望

• 用户手册
• API文档

Answer 3

你可以做得比审查DOD-STD-2178A数据项描述差很多对于软件设计文档和版本描述文档。

SDD描述了软件的设计。 VDD描述了封装，包括如何安装（解包，编译，加载，设置）。