【电子通识】写出优秀文档的8大秘籍

本文主要是介绍【电子通识】写出优秀文档的8大秘籍，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

在日常工作中如开会（写会议纪要）、整理方案（写可行性分析报告、方案评审报告）、问题复盘（写问题分析报告）等工作场景，少不了文档做辅助。因此，如何写出优秀的文档、将信息清晰准确地传递出来，是困扰很多硬件人的难题。

1.无从下手

        工作不是在已知中重复，那样就是流水线的工作。文档书写只是工作内容的一种呈现方式。文档写得好需要内容清晰流畅。其中包含了两个层面的问题：
        1. 想清楚：我们对这件事的思考是否深入、逻辑是否自洽、准备工作够不够扎实。
        2. 讲清楚：有没有展示读者关心的内容，且清晰易懂。

工作是要不断闯过新的难关，所以在写文档过程中，当你感到无从下手时不要太慌。试着定义清楚要解决的问题，收集资料、发散思考，再逐步收敛出结论或观点。
完成这一步，我们就可以开始考虑如何呈现和组织信息了。

2.用户至上

从用户角度出发。文档写出来是给用户看的，所以读者无疑是文档的最终用户。那么如何最快地从个人至上转为用户至上呢？试试问自己三个问题：

写文档的目标是什么？
如果写一份“产品需求文档”，那我们的沟通目标就是“评审一次通过”！这时我们就要评估文档里写的内容，能不能帮助我达到目标？
文档的用户都是谁？
在写文档时一定要结合文档的使用场景和最终的用户，例如一份“可行性分析报告”材料，读者往往包括管理者+协作者+信息同步对象。
用户知道什么？
我清楚掌握 100% 的背景信息，但我的用户们知道多少？是否要把背景信息补全？
用户想知道什么？

假想一下，如果只让用户提 3 个问题，用户会问些什么？

想清楚这些问题，我们大概率对于要在文档里写什么有把握了。

3.文档结构化

文档往往包含开头、正文、结尾，三部分内容，每个部分内容都各有分工。在这样的大框架下，正文结构就像骨骼，将文档要表达的观点串联起来。

我们将每个部分拆开看：

开头：好的开头让读者更快了解信息。将背景、要解决什么问题、建议方案精简地总结在开头，让读者快速浏览后心里产生一个问号❓，紧接着我们再用正文解答读者的疑问。
正文：正文的维度划分就像预告片，为读者展现了你的解决思路。在实际操作中，建议每个部分结论先行，论据紧随，这也被称之为“金字塔结构”。
结尾：结尾主要起到“敲黑板划重点”的作用，加强读者对问题的理解，同时明确下一个阶段的动作。

什么是金字塔结构？

任何一件事都有一个中心论点，中心论点可以划分成3～7个分论点，分论点又可以由3～7个论据支撑，层层拓展，这个结构由上至下呈金字塔状。

4.呈现形式

        结构梳理清楚后，在具体的呈现形式上，也有方法可循
        1. 借助图表
                  涉及到大量数据的，选择表格比打一堆文字更一目了然。毕竟一图顶千言。
                  还有一些甘特图、脑图、泳道图等不同的图形化表达方式，可以结合内容针对性选择。
        2. 通过加粗 / 标记颜色 / 斜体等方式高亮重点信息
                  高亮内容适用于总结句或关键数据，建议大家克制使用，否则会模糊真正的重点。

不过，文档并不需要参与“选美”。选择合适的呈现形式更多是为了清晰传递信息，但不意味着我们需要“过度包装”，花费大量时间去美化和修饰。

5.保持精简

        敲下的每个字都是心血，实在不知如何取舍？试试以下技巧：
        1. 不要假设读者“什么都不知道”。认清读者需求，避免事无巨细，信息过载。
        2. 善于总结归纳。人的记忆条目是 7（±2）条，归类之后会减少人的记忆成本。
        3. 对自己残忍一些！拿捏不准的的时候，问自己一个问题：如果去掉这部分，是否会明显出现信息的减损？如果答案不是一个肯定的 Yes，那就是一个肯定的 No。

6.清晰表达，说人话

文档内容语言的表述上，简而言之就是三个字：说人话！
        在文档语言组织上，不要让读者猜可以作为参考原则。各种黑话和高深词汇并不会让你的文档看起来高大上，对读者来说反而是一种负担。一个简单的参考标准是：“新同学能读懂吗”？此外读者看到第一句话所产生的疑问，下一句话就给他答案。
        一个示例：如果要在一份可行性分析报告中向 leader 呈现“XXX这个方案可行”，那么 leader 的心路历程和你要呈现的信息大概率会是这样：
这是什么方案？——XXX方案替代现有的XXX，意义在于XXX。
        为什么可行？ —— 经过XXX分析，XXX方案最终优于现有的XXX方案。
        后续要怎么做？ ——接下来我们准备将XXX方案验证导入并提供了实施计划表。

7.细节决定成败

        不断进行自我审查对于打造一篇优秀的文档至关重要，这几个坑需要避开：

        1. 格式检查：并列呈现的信息要对齐，否则你的“房子”看起来会歪歪扭扭；
        2. 错字等细节检查：错别字、大小写、全角/半角标点、单位保持统一、数字小数点等等。

        有时候，一个文档写得太久，容易深陷其中无法自拔。所以在最后关头可以发给几个同事共同检查，或许会带来意想不到的发现。