软件开发文档

软件文档可以分为开发文档和产品文档两大类：

开发文档包括：《功能要求》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。此次我编写的是软件开发文档。

产品文档包括：《产品简介》、《产品技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。

• 《功能函数文档》——包括变量名、变量初值、功能、函数名、参数、如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。

参考链接：

•   https://blog.csdn.net/wiseuc_jianghai/article/details/78894112    （开发文档描述）
•   https://blog.csdn.net/qq_40981268/article/details/81537398    （功能函数文档例子）
•   http://www.chanpin100.com/article/101751    （产品需求文档例子）

注意事项：

排版、逻辑。将重要内容分点描述、将流程性较强的部分用流程图描述、将带数字的内容以图表的形式呈现。

为什么要写软件开发的文档：

• 软件开发有以下几个主要的阶段：需求获取阶段——文档设计阶段——代码实现阶段——测试阶段——维护阶段
• 要想保证一个软件成功开发，必学先写文档（确定需求，确定架构，然后撰写需求分析，概要设计，详细设计）。用户的需求如果确定的明明白白，那么这个软件就已经成功一半了。

编辑器选择：

1.  http://markdownpad.com/    markdown    需下载使用
2.  https://dillinger.io/    dillinger    在线编辑器，缺点：打开不稳定
3.  Online reStructuredText editor    在线编辑器，缺点：无法把中文文档export为pdf
4.  本地编写rst文件，用sphinx打开    本地编辑，crlt+p打印的PDF支持中文格式    （rst文件书写规范：https://zh-sphinx-doc.readthedocs.io/en/latest/rest.html）