原创 我们需要哪些形式的文档

在这里我把我的一些个人的想法跑出来，知识累积是需要一个很长的过程，每个人在工作中会遇到很多的问题，而一个团体往往犯的错误更多，我个人喜欢收集这些问题和做一些记录和筛选，我觉得对于我们来说需要把文档细分成以下几种：

程序文档（Procedures）：这种文档就是我们所作的流程文件，我把重要的给罗列出来。

功能说明书，测试规定书，诊断规范说明书，系统原理图，输入输出图，潜入路径分析，原理图，

可靠性分析，故障树分析，设计失效模式分析，热分析，最坏情况分析，BOM表，印刷电路板PCB图，网表，新元件列表，测试报告


设计指南（Guidelines）：主要包含两部分，
1.我们对上面的程序文档的一些使用经验可以总结出来，
2.对某方面的技术设计完备后所总结出来的指导说明书。

报告（Reports）：这也分两部分
1.我们所做的测试报告的合集
2.如果产生问题我们需要把对设计甚至元件详细整理成报告以方便查阅。

经验教训（Lesson Learn）
我们需要把芝麻绿豆大小的事情按分类严格的记录下来，因为我们的经验对后面的设计非常重要，而且我们不可能在脑子里面把所有的东西全部记录下来，那是不可能的。

清单（Checklists）：对一个过程的主要方面的摘要，以确保正确的结果。
我们做完lesson learn 以后结合程序文档，我们就可以在每个阶段不断的设置不同的清单以方便我们的检查，如果通过了我们就可以完成这个节点，如果存在Issue，就把它放入IssueList中。

问题列表（Issue List）
我们在项目中会遇到无数的问题，因此我们需要整理出完整的Issue List,这个对于我们把握哪些问题点非常重要，它主要分，已经解决的，待解决的。

最后是教程（Tutorials）
这个部分就是无私奉献了，把所有的入门的和复杂的整理出来后，可以做出详细的教程给别人使用，在内部培训（或者交流会）上的时候展示出来作为初级学习材料。

如果有可能可以把自己做的最出色的一些文档做成示范的例子，这样保证不同的人在交换相同的文档的时候能有一些相同的规范。

我们经常看到的APPlication Note其实并不是太实用，一般这种格式的内容是从芯片开始的。另外Whitepaper其实就是教程的一种，只不过叫法不一样罢了，欢迎大家补充。

我最头痛的问题就是管理这些数量庞大的文件，如何快速的检索了，国外有不少的知识管理软件，如果有机会找个免费的把这些东西整理好也是个愉快的事情。