文档不注重形式，重点在于可以清晰表达自己的意思，想别人展示清晰的表达，
分为两步 先思考（总分总），再表达（总分）：
1.思考：先一条条思考，最终下结论
2.表达：先下结论，再逐条分析表述
如何清晰表达文档，总结一下几点：
1.看文档的人是谁
2.文档中重要的词汇要红线标注
3.表达内容带有层次感：比如画一个房子，第一个页面画出框架展示，第二个页面复制第一个页面再此基础上舔砖加瓦，根据当时的复杂程度来确认具体分出多少个页面
4.注意文档的文字大小、文字间距、段落间距，考虑到读者看文档的舒适程度。
5.文档若分几条信息表述，那最好把这几条信息用数字的格式清晰的标好
如：
1.1 --------
1.1.1-----
1.1.2----
1.2---------
6.文档若有时间的节点可以考虑用时间轴来总结
7.文档用词最好前后统一
8.文档结尾可能要加个落地页，表示文档已结束：如：“谢谢观看！” 等等
9.文档文字的颜色和文档背景一定要对比鲜明清晰，考虑读者的观看清晰度。
10.文档名称要清晰表达：比如： 00-刘晓明-标题名称-2018/09/05
dart官方文档中的 【Effective Dart】 规范主要分为四个部分： 样式规范 文档规范 使用规范 设计...
dart官方文档中的 【Effective Dart】 规范主要分为四个部分： 样式规范 文档规范 使用规范 设计...
文档不注重形式，重点在于可以清晰表达自己的意思，想别人展示清晰的表达， 分为两步 先思考（总分总），再表达（总分）...
本文来自dart官方文档中的 【Effective Dart】 规范主要分为四个部分： 样式规范 文档规范 使用规...
Swift开发规范 此文档与Apple官方Swift代码规范文档不冲突，只是在官方文档的基础上增加了的部分规范。 ...
Promises/A+规范文档Promises/A+规范文档中文翻译 Promise标准： 拥有一个then方法 ...
石墨文档：微信小程序开发规范文档
规范化 工程结构规范 编码格式规范 前后端接口规范 文档书写规范 Git分支管理规范 Commit描述规范 交互设...
一、命名规范 1. 文件命名规范 项目命名词（或项目编号）＿文件命名词＿日期＿V版本号.文件后缀 项目＿文件描述＿...
本文章转载于搜狗测试 引言 流程和规范，是控制软件质量不可或缺的一种手段。在现在复杂的软件开发流程中，任何一个环节...
本文标题：文档规范
本文链接：https://www.haomeiwen.com/subject/mvvawftx.html
网友评论