假如你有过 Technical Writer 练习或任务经历，那么对技巧写作的流程应当曾经懂得。固然，在很多大年夜公司里，你参加的很可能只是这个流程的某一个环节。比方，你只担任写，或许只担任 review，或许只担任文档架构。比拟之下，在创业公司里，可能会参加多个环节。
假如你是尚未毕业并且也不相干练习经历的在校生，或许曾经任务但有意转行做 Technical Writer 的小搭档，那么可能对技巧写作流程仍存怀疑，或许一孔之见。
差别公司技巧文档流程的分别可能略有差别，但从本质下去看，则迥然差别。无论你在这个流程中的哪个环节，从微不雅上懂得全部流程有助于让你的认识愈加清楚，也有助于在有须要时沉着地承担其余环节的任务。
这里跟大年夜家分享一个完全的技巧文档写作流程，你只有记取六个单词即可。如下图所示：
再阐明一下，你从任务中曾经懂得或即将接触的技巧写作流程不必定与上图完全分歧，但一个完全的流程一般都会涵盖这些内容，差别多数是客不雅分别而已，这一点不必拿出“大年夜家来找茬”的精力逝世磕哦~
筹备阶段的任务重要包含以下多少点：
在写文档之前，须要明白文档须要。你要懂得为什么要写这篇文档，写这篇文档是为了达到什么目标。
也要明白文档受众。受众差别，内容就很可能差别。比方，面向开辟人员跟非开辟人员/一般用户的文档，在内容的构造上就会差别。
还要界定文档范畴。思考并断定这篇文档须要覆盖哪些内容或模块，以及不会涉及哪些内容。如许在之后收集材料的时间就会有所侧重，写的时间也不会含混不定。
有过技巧文档写作经历的小搭档必定会深有同感，假如不懂得某个东西，那么给它写文档几乎太苦楚。
那么当碰到一个让你毫无头绪的陌生主题时，该怎样尽管避免这种苦楚呢？固然就是尽最大年夜可能去懂得了。
但是具体该怎样做呢？简言之，即收集材料。那又该怎样收集材料呢？笔者认为，可能从以下多少点动手：
1）对比较有代表性的同类产品或类似产品的相干文档停止调研，看看他人的文档是怎样做的。
在一窍不通的时间，鉴戒他人的经验做法不掉为一种好的抉择。经由过程对多少产业物的文档停止对比，你就可能对本人要写的文档树破一个大年夜致的框架。
须要留神的是，鉴戒不是照搬，只用于供给思绪；产品差别，文档的构造打算也会有差别。
2）采取最有效的方法尽力收集与所写文档相干的各种材料。
收集的材料经过 Technical Writer 的摘删构造，很可能就会成为发布文档的一部分。
收集材料的方法有很多，像收集查抄、考察问卷、访谈、实验，以及邮件探究、报告、技巧文章等等。究竟该利用哪种方法要具体分析，须要你根据文档须要、Deadline、已有材料的丰富水同等要素，来抉择能疾速而正确地收集到所需材料的方法。
有些主题的写作，经由过程收集查抄可能多少乎无法给你供给任何帮助。即就是这类内容，你也可能从开辟人员那边获得一些材料，可能根据本人的须要请他们帮助供给材料，抑或是经由过程外部体系中的开辟阐明跟探究获取所需信息。
对软件类的产品文档，即便有了一些技巧材料，也每每须要 Technical Writer 本人利用一遍，从而对操纵步调有一个直不雅的懂得，获得文档写作的一手材料。
当材料收集得差未多少的时间就可能构造这篇文档的具体构造了，之前对类似产品的调研或许可能在此时助你一臂之力。
对罕见的产品利用指南，一般按照安装或利用的次序停止构造；对其余一些非指南类的文档，也应遵守必定的次序或逻辑。
其余，还需考虑该文档能否须要配图，能否须要利用表格。假如须要配图，明白是须要他人帮助供给，还是须要本人实现。画一个较复杂的图也是一件蛮耗时的变乱，花费的时光也需考虑在内。
有了具体的文档架构之后，就可能停止下一步的写作了。
假如做好了前多少步的任务，写作将变得非常简单，你只有把响应的内容正确地填到文档架构中。在这个过程中，你须要写一个个段落或许具体的操纵步调。这是一个反应你的言语跟写作功底的时辰。
有的 Technical Writing 书籍中说到，在写文档的时间不必在意语法、说话跟标点，认为这些细节应当在 Revision 阶段完美。
我对此有差其余见解。一个合格的 Technical Writer 本身应当有精良的言语功底，像语法、说话跟标点这种最基本的细节本就不该成为一个须要单独处理的成绩。标准的语法、得体的说话、正确的标点应当曾经成为一种不须要额定付出精力、也多少乎不会占用额准时光的写作习气。
假如写作的初稿比较粗糙，有很多须要修改的小细节，这必定会增大年夜 review 时的任务量跟时光本钱，从而延缓文档流程。
或许，对有精巧化分工、每团体只担任一个小环节的大年夜企业，可能采取这种方法。但是，对疾速开展、须要文档敏捷开辟的创业公司，这种就不实用了。
写完文档第一稿后，一般都须要进一步修改完美。这里的 Revision 指的是 review 之后的修改，所以这一步也可能叫作： Review & Revision 。
那么须要谁来 review 呢？技巧文档平日须要请其他小搭档停止两种 review，即：
收到 reviewer 的反应之后，Technical Writer 须要及时作出断定跟修改，有不明白的处所需跟 reviewer 探究断定。改完之后，再请 reviewer 看一下。假如又发明白新的成绩，那么还须要再次修改。这个 review - revise 的过程可能会反复多少次，很正常。
固然，在请他人 review 之前，Technical Writer 也可能先本人 review 一遍，尽管避免初级错误，不挥霍他人的时光。
哈哈，成绩又来了~平日，刚写完一篇文章的人是很不甘心再去看本人写的东西的，此时就可能利用一些语法拼写检查的小东西来帮助你了。
我在之前的一篇文章 Technical Writer 一般任务中好用的小东西 中有推荐，有须要的小搭档可能戳链接去瞅瞅~
假如你感到本人充足细心，基本不须要小东西来帮助你，我佩服你的才能，但还是倡议用一下小东西。因为，你可能也会有状况不好的时间，有疲惫打盹儿的时间，有不晓得本人写了一堆什么鬼东西的时间……不要跟本人跟小东西过不去。
等文档定稿之后，就可能在平台上发布了，一般很轻易操纵。差其余公司的文档发布平台也会纷歧样，Technical Writer 利用的写作东西也纷歧样。
文档发布之后，并不代表着结束。根据我的任务经历，即就是曾经发布的文档，也仍然有可能存在成绩，无论是大年夜公司还是小公司的文档。比方：未发明的文字错误、掉效的链接、与最新的产品已不婚配的描述跟步调等。Technical Writer 须要及时跟进产品静态，以便及时更新文档。
写技巧文档不是与日俱增的，只有产品在更新，就须要 Technical Writer 一直保护下去。
以上分享的是一个完全的技巧文档从零到有的过程。一般任务中，偶然不须要重新开端，而只是对原有文档的增删修改，那就可能省去一些响应的环节。
假如你也是一枚 Technical Writer，也等待听到你对技巧写作流程的见解，欢送留言交换哦~
Reference:
你可能想读 ：
Technical Writer 一般任务中好用的小东西 技巧翻译须要有 Technical Writer 的 sense 深度剖析对于技巧翻译的六个认知误区 怎样让你的内容输出愈加专业更有计划感？ 书单 | 有哪些技巧传播从业者必知必看的书籍？ 有哪些合适技巧传播从业者关注的优质博客？（一） 有哪些合适技巧传播从业者关注的优质博客？（二） 经验分享 | 来自 11 位 Technical Writer 前辈的职业开展倡议（上篇） 经验分享 | 来自 11 位 Technical Writer 前辈的职业开展倡议（下篇） 英语技巧文档的标题究竟该大年夜写还是小写？ 怎样利用正则表达式批量增加跟删除字符？ Markdown：写技巧文档、团体博客跟读书笔记都很好用的轻量级标记言语 怎样为 Markdown 文件主动生成目录？ 技巧写作实例剖析 | 简洁等于美 两分钟兴趣解读 Technical Writer 若离开懂得，直译得再正确又有何意？ 优质译文不该止于正确，还要 Well-Organized 写在入职技巧型创业公司 PingCAP 一个月之后 揭秘 Technical Writer 的任务情况 | 参加 PingCAP 五个月的员工休会记
-END-