文档编写要点

1. 一个对此文档涉及到的内容很陌生的人,查看此完档时,能不需要自己额外去查阅资料

2. 出现的名词,概念都要解释清楚

3. 图文并茂

4. 文档要很有条理,格式统一,先搭出基本框架,再添内容。例如问题总结类的文档

每个问题应该分为问题描述,原因分析,解决方法,解决方法是否有不当之处,是否还有其他解决方法,是否有遗留问题等几个方面来说!

这和说话、做事是统一的,N 件事情,每件事情的现状,起因,经过,结果,后续会怎样等

你可能感兴趣的:(框架,文档)