写点什么

文档书写规范

作者:甜甜的白桃
  • 2022 年 6 月 09 日
  • 本文字数:574 字

    阅读完需:约 2 分钟

文档书写规范

写在前面:

​在日常工作中,经常会整理“SDK 接入说明”和“经验总结”相关的文档。这些文档不仅要提供给客户看,自己工作时也会经常查阅参考。所以文档书写的准确和美观,尤为重要。下面可都是干货哦,看到就是赚到!

1、序号,符合层次顺序

上下级标题需符合层次顺序,不出现断序。

第一层:一、二、三、第二层:(一)(二)(三)第三层:1. 2. 3. 或 1、2、3、第四层:(1)(2)(3)第五层:①②③ 或 1)2)3)第六层:A. B. C. 或 (A)(B)(C)第七层:a. b. c. 或 (a)(b)(c)
复制代码

2、冒号,统一使用

要么都使用,要么都不使用,不跳着使用。

❌ 错误示例如下

标题一、XXXX:标题二、XXXX标题三、XXXX
复制代码

3、目录,适当新增

当文档篇幅较长时,为了让阅读者快速了解都有哪些内容,适当插入目录。

4、红色字体,少而精

少而精才具有强调意义,不滥用红色的字体。

❌ 错误示例如下


5、数据,准确

例如百分比数据,一定要相加为 100%,注意四舍五入;

❌ 错误示例如下

6、多块内容,统一语顺

全文统一先说什么模块,后说什么模块。

7、总结性词语,适当加

在一些操作指引前,添加总结性词语,会更容易知道未来要做哪些事情。

❌ 错误示例如下

8、流程图,简单清晰

流程图尽量不要看起来太复杂、颜色太刺眼。

❌ 错误示例如下


9、口语化,避免出现

避免出现口语化的描述。

❌ 错误示例如下


👉如果在阅读过程中有任何疑问,欢迎在评论区留言参与讨论!

发布于: 刚刚阅读数: 5
用户头像

👩‍🦰一名在路上的,测试开发工程师 2021.02.23 加入

⭐做好每个当下,美好一定会不期而遇! 2018年 入职大连某公司,负责移动端SDK开发 2015年 入职腾讯,负责手机QQ iOS开发 软件评测师认证 高中和中职信息技术教师资格证

评论

发布
暂无评论
文档书写规范_文档_甜甜的白桃_InfoQ写作社区