关于技术文档编写

技术文档最好从不同的角度来写，什么东西都写在一起是很容易造成混乱的。

程序文档要从几个方面来介绍：

1，设计思路-尽量简略写下设计初期和设计过程中的思路及思路转变过程。
  如果思想转变比较多，应该对最后的想法做解释，但不
  能忽略重要的思想转变。（可选）

2，架构-架构分为很多种架构，就是由什么重要的东西组成，也学一个执行流程
  中的重要步骤也是架构，主要描述有什么存在，目前我不好
  给出明确定义，就是说明有什么，这一部分要简略，不能太复杂描述

3，资料-列出架构中重要的东西所涉及到的资料，数据表格，枚举，类型，等等，
  凡是在程序中能够用到的，都放在资料库中进行说明

4，教程-通过一组操作过程来说明每一个功能接口的使用方法，包括配置文件的配置过程。
  实现一个完整的功能演示，给出完整事例代码。

5，检验-文档写出来是用来读的，不是没有用的，所以，一定要找人来读，
  修正和补充这个步骤非常重要，大量表达能力上的问题都
  会在这个时候报漏出来，并加以改正和完善。

 

转载于:https://www.cnblogs.com/Anima64/archive/2008/07/30/1256807.html