技术文档工程师和程序员的关系,有点像记者和消息源——你得不断去打扰对方,问一些可能让人不舒服的问题。只是我们的目的不是写新闻,而是把产品讲清楚。
这些年我合作过的程序员不少,他们对文档的态度千差万别。有人让你如沐春风,有人让你怀疑人生。我大概归纳了5种典型类型,以下描述基于真实经历,性别用"他"只是方便叙述,实际上每种类型男女都有。
打开网易新闻 查看精彩图片
类型一:金毛寻回犬型
这是技术文档工程师的最爱。如果他是条狗,绝对是金毛——温顺、配合、真心投入项目。你问他问题不用担心被翻白眼,他会认真看你的修改建议,积极参与讨论,下次交稿明显比上次好。我曾经和同事抢过谁负责对接这位"金毛男孩"的文档,最后差点打起来。
最佳合作对象,没有之一。
类型二:"人人都会写"型
他觉得写文档没什么技术含量。"前置条件放文档末尾?这是设计如此。""概念不清楚?我觉得够清楚了。""再加细节?太长了,现在就已经够长了。"他总说"我知道怎么写,我自己来",却不明白技术文档不只是把字码上去,还要考虑信息结构、简洁度和读者需求。结果通常是:满篇术语、解释模糊、信息缺失、结构混乱——用户看得比报错还难受。
最打击工作积极性的类型。
类型三:"我什么都不知道"型
每家公司都有。你去找他询问他负责维护的项目,他一脸茫然:"我不知道。"换种问法,还是:"我不知道。"你分不清他是真不懂,还是装不懂好逃避写文档。还有个变种:其实不懂,但假装懂,给出一个听起来对、细想全错的答案。
(原文此处截断,未提供后续两种类型的完整描述)
热门跟贴