文档习惯之格式篇 用文档逼疯一个人的五种办法

1 前言

大疆是个特别酷,特别有工程师文化的公司。去年看了大疆的动画片《RoboMaster》,激动不已,更让我增加了对大疆的好感。为什么讲文档习惯要提到大疆呢?最近在虎嗅看到一篇大疆的报道《大疆走下神坛》,文章虽然主要是分析大疆的现状和未来思路,但本能手还是从大篇幅中抓住了重点。

一位大疆内部人士称,汪滔(大疆CEO)的研发体系堪称国内效率最高,在技术研发上,他建立了一套规则。一位从大疆离职的研发人员向全天候科技证实,汪滔的研发习惯非常好,技术文档写得可以当教科书,他会把技术需求分门别类排好,并且把每个流程从哪个环节去调取都列清楚,“有这种研发习惯的人很难不成功”。

成功总得有一些必要条件,文档习惯就是其中最重要的一个。开发者们可能是仅次于文字工作者之外,需要写最多文字的群体了。所以在开发者中强调文档习惯是特别有必要的。

之前我已经分享过几篇文档习惯的心得,侧重于文字的表达上,文档思路上。

麦肯锡教给我的写作武器:如何讲好一句话

如何讲好一句话,最主要的是主语谓语要清晰。

麦肯锡教给我的写作武器:连接词是文章通顺的灵魂

运用逻辑连接词可以信息之间的关系明了,减轻接收者的负担,更容易向接收者传达意思。

文档啊,最重要的还是层次感

金字塔结构就是用一种见树又见林的方式来呈现出内容框架,我认为是文档写作最重要的一点。表面上是文档结构,其实背后更多的是对内容的逻辑思考。


如果说文档思路是灵魂,文字是肉体,那么文档格式则是衣服。最近遇到了几件事情,促使我想分享下对于文档格式部分的一些想法。

2 起因

小能手前段时间负责了消防国标协议的修改,使其拓展支持 LoRa、LoRaWAN 类设备。在这份协议上还修改了其他同事没关注到诸多字体、表格格式问题,完善了标题书签等等。

最近其他同事更新了协议,内容上是没什么问题,就是格式上有一点细节没注意。比如下面这个地方,文档默认的字体是宋体五号,接下来的第二点采用了另外三种不同的字体。

我们部门里的小伙伴,最近在更新一份对外的协议上,也出现了一点字体格式的问题。

我们都会出现这样的情况,时间忙,项目紧,复制粘贴,所以忽略了这些细节的处理。我有时候也会不小心忘记。其实大家只是需要有人提醒一下,稍微注意下,以后估计都会避免这样的问题了。

本能手由于强迫症,很想让每份文档都干干净净。每次都自己去改文档,那是不可能的。

所以我决定,留下来 写下来!

3 用文档逼疯一个人的五种办法

小兄弟,我看你骨骼惊奇,我这刚好有一本秘籍,杀人于无形,慢慢说给你。

3.1 文档框架

第一条 大杀器 - 千万要隐藏住文档结构

是的,这条最厉害。丢一个几十页的文档过去,一定不要带书签,最好目录也不要带。就是要让他读不下去,他肯定会觉得是自己能力不行,而不会说我们文档写的差,因为大部分文档都这个德行。

文档结构这种灵魂性的东西,一定不要显露出来,让对方去花时间琢磨,在无声无息中奠定我们的主导地位。千万不要让对方看到本能手写的那篇笔记《文档啊,最重要的还是层次感》。

第二条 文档结构图不统一

这个办法杀伤力也还可以,一定要故意丢掉一些标题,或者把一些正文转为标题。从这些细节上让对方难受,不积跬步无以至千里,不积小错无以磨死对方。

一定不要告诉对方,在 word 的样式中可以修改为 “标题x” 样式就可以实现这样的效果了。

3.2 文档排版

第三条 巧妙地用空白来混淆我们的意图

通常人们会通过文档里的空白,来对段落意思做逻辑分割。意思相近的段落聚拢,相互独立的段落分开,可以使用空行,或者用分割线等等。

所以我们一定要巧妙地利用空白来折磨对方。当然,不仅仅是空行了,行间距也是悄无声息的杀手锏。

像下面这样规范的做法,就没有什么杀伤力了。

这在代码习惯里也分享过,尤其是卧底在敌对公司里的开发者们,一定要善于利用空白哦。没事多来几个空行,特别不要让其他人在一个屏幕里完整看完函数。或者把意思相差较大的函数偏偏聚拢在一起,嘿嘿,神不知鬼不觉。

第四条 缩进时也可以抖下机灵

杀死那些强迫症,分分钟的事儿。

3.3 文档字体

第五条 字体混用

逼疯一个人,还有一个特别重要的办法。我们可以从别的文档上复制过来,特别是 WEB 页面,这样原本的字体格式也都复制过来了。

这就是个不错的例子,就是由于 WEB 字体复制引入的多种字体格式。

这样做的话,阅读者总觉得文档不够规范,但是他又觉察不出到底是哪出了问题。千万不要通过“清除格式”来让字体统一,我们便可以又一次逼疯一个人。

4 总结

好了,这便是本能手这个关于文档编写格式的分享,利用文档逼疯一个人的五种办法,神不知鬼不觉。

希望广大卧底在敌对公司的朋友们勤加练习,如果成功把公司搞破产了,记得回来感谢下本能手。


作者其他精彩文章:

  • 行业围观
    深度报道 第1个从太空发回的LoRa信号(含视频)
    LoRaWAN介绍 - LoRa从业者读这篇就够了
    中兴对华为NB-IoT的大反击 - CLAA
    最高旨意下达,Sigfox在中国鸣枪开干

  • 心得分享
    文档啊,最重要的还是层次感
    技术管理入门课_先做个不讨厌的人
    你一定没见过这么有意思的电路板


你可能感兴趣的:(软技能)