金字塔：文档论述：1， 同一组不超过7句话 2 纵向：解决读者疑惑 3. 横向：同一层次，无交叉，无空白 4.序言：读者和作者在同一水平线上
结论现行，以上统下，归类分组，逻辑递进。
发命令：1，对收件人和负责人归类，也对问题进行分类，让对应的人找到自己的内容 2.下命令：who（谁）when（在什么时间） what（完成什么事情）
会议纪要：对所有信息归类和分高低层次；在同一层次，可以用时间顺序或者逻辑推演顺序。
一页文档的结构：1. 结论先行，什么原则和基础的大框架，放在前面。2 繁琐的描述，不如用图示来搞定，结合好懂的文字。
3 避免规范里再嵌套 规范，保证第一眼就能看懂规范。复杂的内容列出出处和其他来源。 学会举例子，来说明规则，
邮件里的决策：1 说明需要选择的可选项，说明个人的偏向； 2. 表格：列出所有方案的实现，优缺点，区别，兼容性等等。
技术文档：1. 用step bystep 的步骤，而不是 首先，然后，最后。2. 同时，首先，不仅，而且，然后，最后。 3. 程序: 部分，完全，等，仅仅，基本。几乎。
4. 竟然，大概，居然，难道，究竟，偏偏 4. 他，这样的代词。5 一词多义，避免。 6. 名词的名词和名词 动词名词的名词2 名词1 名词2 名词3
不用俚语，时间也要具体的时间，不要抽象。7 版本，模块，单板，术语。全文保持一致。
语句：陈述句，剪短，一个动词。主动语句。
去掉 与主题无关的修饰，不需要应用广泛或者为了方便起见；简单句和陈述句，不要复杂句，避免情感色彩。
宾语多：用列表的方式，来列举所有的元素。不要用一句话去解释所有的东西，去掉冗杂的状语。
段落：一个段落，一个中心句。结论在句首，说明，展开，论据论述。一段落4句话，多使用列表，图，表。
列表：有序，用1，2，3，4 有时间顺序；无序：无序列表
图：文字应用，如图几；图形和正文在一页尽量；图配文，每一部分的特征，作用以及符号，正文有说明。
step bystep : 1, 使用场景(需要执行完成的操作) 2. 明确任务（完成目标后 目标和结果） 3. 有过程
标题：1. 任务的中心任务，动宾结构，反应任务的目的
摘要：1.应用场景，进一步解释。任务的目标解释，和一定的背景。
前提：1. 执行任务前的准备条件，必备的工作，文件，配置和预先规划的数据。不用具体的步骤，基本的条件不要重述。
步骤：为了完成每一个任务，必须遵循的操作过程。每一步独立的操作，连贯的动作，可以作为一个步骤。
步骤：界面截图，参数说明使用表格，文字说明步骤简洁直接。有序：时间顺序，无序：并列的方法。
步骤：执行的菜单命令，参数解释，步骤达成的效果，辅助说明。
举例子：举例子的数据规划，以及对应的数据规划或者组网结构；举例步骤中的步骤。典型案例。
1. 固定步骤 时间顺序； 2. 子步骤：复杂的分成简单的 3. 可选：任何一个方法都可以 4. 分支：不同的选择，针对不同的情况和目的，if，then。
5 跳转：故障排查，告警处理，失败项处理。跳到下下步骤。
网友评论