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

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

1.无从下手

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

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

2.用户至上

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

  1. 写文档的目标是什么?

    如果写一份“产品需求文档”,那我们的沟通目标就是“评审一次通过”!这时我们就要评估文档里写的内容,能不能帮助我达到目标?
  2. 文档的用户都是谁?

    在写文档时一定要结合文档的使用场景和最终的用户,例如一份“可行性分析报告”材料,读者往往包括管理者+协作者+信息同步对象。
  3. 用户知道什么?

    我清楚掌握 100% 的背景信息,但我的用户们知道多少?是否要把背景信息补全?
  4. 用户想知道什么?

        假想一下,如果只让用户提 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. 错字等细节检查:错别字、大小写、全角/半角标点、单位保持统一、数字小数点等等。
 
        有时候,一个文档写得太久,容易深陷其中无法自拔。所以在最后关头可以发给几个同事共同检查,或许会带来意想不到的发现。

8.不断迭代

        好的产品需要结合用户需求不断迭代,好的文档也是如此。

        例如,从书籍、外部网络等渠道查看到的“优秀作品”时,我们可以先去看这些文档分成几个板块,每个板块包含哪些内容,作者背后的思考逻辑是什么。将这些能够启发自己的文档收藏起来,是提升文档水平的坚实一步。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/661522.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

牛客网刷题 | BC70 计算单位阶跃函数

目前主要分为三个专栏,后续还会添加: 专栏如下: C语言刷题解析 C语言系列文章 我的成长经历 感谢阅读! 初来乍到,如有错误请指出,感谢! 描述 KiKi最近学习了信号…

【吊打面试官系列】Java高并发篇 - 为什么 wait 和 notify 方法要在同步块中调用?

大家好,我是锋哥。今天分享关于 【为什么 wait 和 notify 方法要在同步块中调用?】面试题,希望对大家有帮助; 为什么 wait 和 notify 方法要在同步块中调用? Java API 强制要求这样做,如果你不这么做&#…

【个人博客搭建】(15)Redis缓存使用

1、下载nuget包:StackExchange.Redis; 并引用 using StackExchange.Redis; 2、配置信息 /* Redis缓存配置 */"Redis": {"Enabled": true,"ConnectionString": "127.0.0.1:6379,password123456"} 3、配置模型 public cla…

小剧场短剧影视小程序源码_后端PHP

项目运行截图 源码贡献 https://githubs.xyz/boot?app42 部署说明 linux/win任选 PHP版本:7.3/7.2(测试时我用的7.2要安装sg扩展 ) 批量替换域名http://video.owoii.com更换为你的 批量替换域名http://120.79.77.163:1更换为你的 这两个…

PotatoPie 4.0 实验教程(34) —— FPGA实现摄像头图像二值化腐蚀效果

链接直达 https://item.taobao.com/item.htm?ftt&id776516984361 图像二值化腐蚀处理有什么作用? 图像二值化腐蚀处理在图像处理中起到了以下作用: 物体分割与提取:在图像二值化之后,通过腐蚀操作可以消除噪声、连接相邻的…

uniapp 对接 Apple 登录

由于苹果要求App使用第三方登录必须要求接入Apple登录 不然审核不过 所以: 一、勾选苹果登录 二、 设置AppId Sign In Apple 设置完成重新生成描述文件 !!!!证书没关系 示例代码: async appleLogin…

软件定义汽车落地的五大关键要素

1、架构升级 1.1 软件架构:分层解耦、服务化、API 接口标准化 随着企业向软件定义汽车开发方法的转变,软件架构也需要同步进行升级,引入面向服务的架构(Service-Oriented Architecture,简称 SOA)方法论。…

数据结构––队列

1.队列的定义 2.队列的分类 2.1循环队 2.2链式队 3.队列的实现 3.1循环队 3.1.1声明 typedef int QDataType; #define MAXSIZE 50 //定义元素的最大个数 /*循环队列的顺序存储结构*/ typedef struct {QDataType *data;int front; //头指针int rear; //尾指针 }Queue;…

Macos安装OrbStack

什么是OrbStack OrbStack 是一种在 macOS 上运行容器和 Linux 机器的快速、轻便和简单方法。它是 Docker Desktop 和 WSL 的超强替代品,所有这些都在一个易于使用的应用程序中。 在Macos M系列芯片上,经常遇到docker镜像不兼容的问题,此时使…

【八大排序(三)】快速排序

❣博主主页: 33的博客❣ ▶️文章专栏分类:八大排序◀️ 🚚我的代码仓库: 33的代码仓库🚚 🫵🫵🫵关注我带你了解更多排序知识 目录 1.前言2.快速排序2.1概念2.2画图理解2.3递归代码实现2.3.1Hoare法2.3.2挖坑法2.3.3前…

Java 写一个死锁的例子

public class DeadLock {public static void main(String[] args) {Object lock1 new Object();Object lock2 new Object();new Thread(new A(lock1,lock2),"线程A").start();new Thread(new B(lock1,lock2),"线程B").start();} }class A implements Run…

WORD排版常见问题与解决方案

前言 近期使用word软件进行论文排版工作,遇到了一些常见的问题,记录一下,避免遗忘。 基本配置 系统环境:win10/win11 word版本:Microsoft Office LTSC 专业增强版 2021 问题与解决方案 问题1:页眉显示内…