[doc_way]我“司”技术写作

117 阅读4分钟

这是一篇自箴。余从事技术写作若干年,自感其中诀窍无非本文所述几点。以之为下限,可保文档质量无虞;每点尚可不断穷深,使己在此行不断精进。故记录下来,作为对我日常工作的规谏。

标题用“司”,意在强调我“掌控”我的工作,明确动机在我,而非“服役”于它。

image

✽ 技术挖进去

挖技术不是说懂代码、跑测试,这些都只是获取信息的途径(如同合情推理也可获得信息一样)。挖技术指将信息转化为对事物如何运作的认识。

一个功能要思考它为什么出现,基于它其他对象的工作方式发生什么变化等。这样把技术搞清楚后,再考虑如何写。如果搞不清楚,就主动寻求帮助去搞清楚。一个问题搞不清楚看似只影响眼前,糊弄一下也就过去,实则断送了搞清楚其他更困难问题的可能性。

内容好思量

写作不是码字拼数,更不是复制粘贴,而是一场经深思熟虑的对话。面对一张纸,犹如面对一个/群人,去写就是去讲。讲不明白我知道别人会追问、质疑。带着这样的担忧去组织内容,而不是抱着写了也没人看的心态,或者写了只图需求人满意的目的,写作的结果大相径庭。

敬畏心从潜意识层面驱策作者自己来讲述,而非简单照搬别人的说法。我理解到哪一步,就讲到哪一层,而不是滥竽充数。试想拿着一份晦涩难懂的原稿,自己都云来雾去的,照搬它去向别人复述,怎可期望别人能懂?

✽ 下笔有逻辑

一个词句、段落、文档,乃至教程、手册等写成什么样子,在开始写作前都要有一个大体把握。把握即钩玄提要,其内涵是自顶而下;与之相对,行动的内涵是从底向上。

把握如同管理中的决策。作者管理一批文字,这批文字服从管理者(作者)的愿景、方法。愿景决定文字走向哪里、如何发展,方法是对文字的统一约束。写作前对内容的把握,就是基于愿景和方法做出的一个决策:决策有力指导后续行动,而对行动结果不具直接影响。(在我看来,这恰是写作的一个妙处,发挥行动中的有限自由以创作超出预期的结果。)与之相对,没有决策的行动漫无目的、毫无章法,注定会失败。

好的决策向着愿景循序渐进。纵使迷失在城市错综街道上,只要紧盯远处的目的地,感知正确的方向,一步步总能抵达。不好的决策跳脱不羁,天马星空,只会让人茫然无措。

✽ 语言耐打磨

语言是我的鞋履,传播我的思想。拿别人的文字来用,难免鞋子有大有小,不总合脚。别人的文字经我消化,吸收为我的思想再从我出,如此“削履适足”使得语言恰如其分。

鞋履合脚也可能磨脚,语言我看虽觉行、读者不定认为行,总归还要打磨。

所谓打磨,无非明意与拆解。意在笔先,然后写作。逻辑拆解要表达的意思,层层剥离,然后为每个意思造句。句中对象指代明确、词性(noun)区分(verb)准确(adverb)、结构布置严谨。句句之间,意思连贯,一气呵成。经过打磨的文字耐读,首先耐得住自己读。一句一文,反复诵咏,自可发觉其间龃龉。耐读的文字藏韵律在其中,为其畅舒己意,而又不逾规矩。

✽ 作品动心思

写作是在作品构建中提炼和演进的一项能力。无作品,不提升。作品不是指我处理完成的几个需求,而是我动用心思创作的新事物。

它“新”是因经我之手:我构思了它、使它诞生;凝视着它,促它改进。我动用在它上面的心思,使它和其他看似一样的文字有差异,即使它们秉持同样的风格而创作。用在作品上的心思也改变了我。无论是一个新的尝试、一个已知技法的实践,乃至对无关事物的观察联想,种种沉淀都使我在构思、凝视下个作品时,再次催生新的想法和努力、再次创作新事物,也再次更新自己。

与之相对,一成不变的方法、思维只能催生陈旧之物,看似熟练操作的背后隐藏着衰朽腐蠹的危机。当陈旧之物不再被需要时,遗留下来的又有什么呢?