与男神女神共话技术写作

最近和一位男神级别的前辈有了面对面交流,又和一位女神级别的前辈有了神交(读了她的书),感觉心里又泛起了很多思考。但是都是片段化的,这里一点那里一点。为了怕自己忘记,先随手记录一下。实在不知道这篇文章该取个什么名字,就当做随笔记吧。

1.关于吸引更多资源和关注

男神:

哭诉做不好是永远没有办法吸引到资源和投入的,一定要先做出来一点成绩,让手握资源的人看到变好的可能性,才会愿意投入资源。

在企业初创期,说是欣欣向荣,不好听一点,也可以说是百废待兴,一切的一切都有待优化,都急需资源。这个时候资源如何分配呢?资本是逐利的,如果只强调投入,没有看见产出,甚至没有预期,可不就像是垃圾股,深居一定位置的人都不会那么傻当成韭菜被收割。

女神:

“哭诉”技术内容重要性,希望引起关注是最无效的。我们要站在哭诉对象的角度,我们能够解决对方工作当中的什么痛点?比如CS关心的是cc和service call。项目经理关心IB。研发同事也很头疼术语不一致,研发文档五花八门的情况。而市场部门希望自己的宣传是有的放矢,不是空中楼阁。这些都可以落实到技术写作规范和高效技术传播中来。而这些都是我们能够吸引资源和关注的好方法,因为看起来是你在帮他们解决问题,而不是你在贩卖你的思想,占用他们的资源。

我:好哭的孩子没奶吃。

2.如何提升团队重要性

男神:

不要把技术文档部门仅仅定位为写作手册,也不要把翻译仅仅定位成语言转换。你的部门如何定位是由你来决定的。千万不要把事情总往外推,固守自己的一亩三分地。如果承担的业务并没有拓展,又如何指望团队的壮大。

所做的工作,如果只是量变,更多管理者会倾向于提高团队效率,而非增加更多人员。只有在质变,业务内容有扩展时,才有可能带来团队的扩展,壮大。

女神:

技术内容不单单是用户手册这么简单,贯穿售前售后各个环境。包括售前的datasheet brochure,售中的用户手册,培训文档,以及售后的升级指导等等。

应该更好发挥技术内容正确性,深挖技术写作价值。能跟把研发,产品和用户之间的知识鸿沟一点点填平。

我: 要想友情不塑料,先要提高你的重要性或者不可替代性。

3.如何保证技术写作源头的正确性

男神:

制定规范,提供模板。

首先,要把规范立起来,哪怕最开始没有人遵循,没关系,自己团队内部先按照规范操练起来。在起效时趁热打铁,再对外推介。最好能够把规范嵌入到公司的流程规范中,并且在作为重要节点的考核项,KPI。

其次,提供必要的模板,越详细越好。在模板中,要把技术写作的理念糅合进去。比如,做好内容分类,任务,概念,参考信息之间不能杂糅。不同类型主题要包含哪些写作要素,在模板中也要包含。一个主题内容不能过长,等等。但是这一切的前提是保证素材正确性,离开正确性谈易读性,易检索性都是无根之萍。

做好把关,对于输入的文档,进行客观量化的质检,必要时弹回重写。产品研发工程师应该承担起手册素材质量的责任,作为职责项目。如果自己研发的产品,自己都说不清,遑论别人?

女神:

提供结构化的内容模板,对于同类型的文档,素材输入时就要按照固化的结构化的模板,告知需要包含哪些内容模块。并把每一个内容模块的要求描述清晰。保证输入的素材完整,无遗漏。同时也会很方便地在对应位置抽提对应信息,极大提高后期加工处理的效率。

我: 世间本来没有路,走的人多了就成了路。走自己的路,让别人跟随你的脚步。

4.面向对象写作,提升客户满意度

男神:

国外客户重视文档,因为没有便捷的语言交流和随时的客户培训解答和service call。所以要做好文档本地化处理,符合所在国家和地区的实际使用需求。

手册不能面面俱到,做成工具书,必要的时候才参考一下。而是要区分场景,指导用户更好完成任务。不能简单把所有信息罗列堆叠在一起,让用户自行判断如何使用。另外,看完手册应该让用户对待完成的事项跃跃欲试,充满信心。而不是忐忑迷茫,觉得困难重重。

女神:

了解你的用户,提供与他们知识和认知水平相当的指导。千万不要把用户当成傻子,写一个复杂图像后处理工作站,要把键盘按键和鼠标控件逐个介绍一遍。如何插拔网线都写大半页纸,都是完全没有必要的哈。

我们要允许一部分手册内容随着用户认知深度提高而“消失”。不是强行删除,而是可以让用户做到视而不见。

虽然,尽量做到简单化看起来是尊重用户,实际上过多冗余信息,对于已经信息过负荷的人来说,都是噪音。没有人愿意被挡做傻子的 吧?要善于与时俱进,动态调整内容策略,更好匹配用户水平。

我: 把自己内存清空,当成是终端用户,再来读读自己的文档吧。我保证不打死我自己。

班门弄斧,现学现卖就先到这里啦,困觉去啦。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,127评论 25 707
  • 自序 1. 不是每个人都能以产品经理为业,但在我看来,产品经理是一类人,他的做事思路与方法可以解决很多实际的生活问...
    沉沦2014阅读 4,362评论 1 19
  • 今天上午培训,下午出去做市场调研,我们组五个人,大家都很努力认真,特别感谢晶晶美女,人漂亮、能聊又勤快,到...
    伽有儿女阅读 187评论 2 3
  • 来北京有一段时间了。两个人手里有一些钱,家里也给了一些。和去一个城市旅行的感觉是不一样的。拿着钱去一个地方旅行,钱...
    桃子姐姐美不美阅读 180评论 0 1
  • 我喜欢一个叫做“叶子”的姑娘,她长着一双杏仁眼,粉嘟嘟的面颊白里透亮,我想任谁在第一眼见到她时,都会不由自主地爱上...
    糖果欣心阅读 325评论 3 2