怎样让一篇技术文档读起来轻松愉快?我整理了以下几点分享给你😆
序号 | 要点 | 说明 |
---|---|---|
1 | 清晰的结构 | 给文档添加目录、标题、子标题; 给文档添加概述,简要概述文章的主题,提供总体视角 给文档添加总结,简要总结文中主要内容,给读者留下深刻印象; |
2 | 通俗的词汇 | 少用行话或术语 |
3 | 简洁的句子 | 注意主谓宾副词形容词的使用 |
4 | 简洁的文档 | 文档只包含和主题相关的内容,避免过多的嵌套或者引用 |
5 | 视觉元素 | 添加图片、图表、流程图等视觉元素 |
6 | 案例或者实例 | 用具体的案例或实例解释技术文档中的抽象概念 |
7 | 示例代码 | 在技术文档中添加示例代码(有运行结果更好),能让读者直观地理解你所描述的技术内容。 |
8 | 内容拆分 | 把复杂的技术及理论分成若干部分,使每个部分的内容少而精,更有针对性 |
9 | 交互式 | 比如采用问答方式、激发读者的兴趣并引起他们的注意 |
🌛
晚安,明天见!