技术文档怎么写(2)

收到 reviewer 的反馈之后,Technical Writer 需要及时作出判断和修改,有不明确的地方需和 reviewer 讨论确定。改完之后,再请 reviewer 看一下。如果又发现了新的问题,那么还需要再次修改。这个 review - revise 的过程可能会反复几次,很正常。

当然,在请他人 review 之前,Technical Writer 也可以先自己 review 一遍,尽量避免低级错误,不浪费他人的时间。

哈哈,问题又来了~通常,刚写完一篇文章的人是很不情愿再去看自己写的东西的,此时就可以使用一些语法拼写检查的小工具来协助你了。

如果你觉得自己足够细心,根本不需要小工具来协助你,我佩服你的能力,但还是建议用一下小工具。因为,你可能也会有状态不好的时候,有疲劳打盹的时候,有不知道自己写了一堆什么鬼东西的时候……不要跟自己和小工具过不去。

6. Delivery 文档交付

等文档定稿之后,就可以在平台上发布了,一般很容易操作。不同的公司的文档发布平台也会不一样,Technical Writer 使用的写作工具也不一样。

文档发布之后,并不代表着结束。根据我的工作经历,即便是已经发布的文档,也依然有可能存在问题,无论是大公司还是小公司的文档。例如:未发现的文字错误、失效的链接、与最新的产品已不匹配的描述和步骤等。Technical Writer 需要及时跟进产品动态,以便及时更新文档。

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/82d06cdc510b5d8a35fab095b41b7961.html