如何写出好的技术文档
余年寄山水
668次浏览
2021年01月19日 08:03
最佳经验
本文由作者推荐
营销战略-庆元旦手抄报图片
如何写出一篇好的技术文档
最近在公司内部的文档评比中表现不佳，
本人回 顾参赛的文档发现有很多地
方需要改进。
以下我列出了几个普遍存在的问题，
供大家参 考，
以提高文档质量。
1
）
文档的格式
好的文档应当是从头到尾保持格式的一致性，这不仅仅是一种美，更是
专业性的一种表现。格式有时 是这样，有时是那样。一篇好的文档不光是内
容写得好，其格式是很重要的一部分。试想，如果我们拿到 了一篇格式上写
得乱七八糟的文档，会影响我们的阅读心情吗？
好格式举例：
a)
标题：黑体，四号，加粗，居中；
b)
摘要及关键词：宋体，小四；
c)
一级标题：小四号，宋体，加粗；
d)
二级标题：小四号，宋体；
e)
正文内容：宋体，小四，不加粗，开头空两字；
f)
行间距：
1.5
倍行距；
2
）
文档的选题
俗话说，“好的选题是成功的一半”。一篇技术文档的选题能够决定文< br>档的价值和效用。好的选题可以规划文档的方向、研究角度和规模，来弥补
贮备的不足。好的选题 可以保证写作的顺利进行，提高研究深度。
那么，好的选题应该具备哪些因素？
a)
能够解决现实中遇到的问题，或产生直接的经济效益；
b)
有一定的技术深度，且对工作有帮助；
c)
内容新颖，其他渠道无法轻易获取，且对未来的工作有帮助；