鲜枣教室自从2017年5月开始正式创立，迄今已有3年多的韶光。这一期间，我们的内容一贯都坚持以技能类科普文章为主，输出了大约400多篇原创。个中绝大部分，都是我写的。
我的想法比较大略，便是希望能够输出普通易懂的技能科普文章，让技能不再呆板，帮助更多人（尤其是即将进入行业的年轻人）理解通信，理解5G、物联网、云打算和大数据这样的ICT领域前沿科技知识。
非常光彩的是，鲜枣教室的内容受到了大家的欢迎，得到了宝贵的认可，也积累了越来越大的影响力。我们现在已经逐渐成为行业里排名前列的技能类内容原创自媒体。
实在，我之以是会选择技能文章写作这条路，和我的个人经历是分不开的。
我曾经在某设备商做了四年的技能支持（个中三年外洋），积累了丰富的通信产品技能知识和实践履历。然后，又做了三年的文档经理，积累了大量的文档写作、文档体系培植、文档质量管理方面的履历。末了，又做了四五年的培训经理，学习如何进行高效的内容表达、如何针对内外部客户进行知识通报。
多元化的职场经历，为我创办鲜枣教室贡献了知识背景和能力根本。
尤其是技能文档写作这一块，我从刚入职就养成了履历随手总结、技能定期积累的日常写作习气，并保持至今，可以说是受益匪浅。
文档，不管是对付员工个人，还是对付企业，都有非常主要的意义。对付技能类公司来说，技能文档的主要性更是不言而喻。它的代价，完备可以等同于产品本身。或者说，技能文档便是产品的一个主要组成部分。
很多人认为文档是产品的附属品，是例行公事的印刷品，这显然是不对的。
文档的根本性子，是贯穿产品生命周期的沉淀积累输出物，是信息通报的主要工具和载体。不同阶段的文档，有不同的浸染。不同的岗位，有不同的文档体系。
在产品设计和研发阶段，有产品设计辅导书、产品功能需求解释书等。在产品工程交付阶段，有版本发布解释、技能辅导书、升级/割接/扩容辅导书等。
产品文档体系的范例
文档还分为内部文档和外部文档。内部文档做事于内部用户，外部文档做事于客户、互助方等外部用户。内外部文档密级不同，内容会有所删减，表述办法和侧重点也会有所不同。
文档用于辅导实际事情。文档质量的好坏，会影响信息通报的准确性和效率，进而影响事情的完成、项目的交付。
例如，产品开通文档太烂，客户看不懂，互助方员工看不懂，乃至自己的工程师也看不懂，就无法依照文档成功完成设备开通或升级割接。文档如果涌现缺点，乃至可能造成严重的事件。
现在市场竞争越来越激烈。有时候，虽然产品本身做得很好，价格也很有上风，但是文档太烂，一样会被客户鄙视，进而拉低了产品的整体竞争力。有损公司品牌形象。
那么，决定产品文档质量的基本要素是什么呢？
有人说，是作者的写作水平。也有人说，是是否有充足的韶光。
实在都不对，基本要素只有一个，那便是钱。
文档写作是一个须要投入大量资源的事情。
首先，须要建立一个完善的文档管理体系，包括文档架构体系，文档职责归属，文档立项、开拓、评审、发布、归档流程以及对应平台等。
其次，须要安排大量的专任或兼任岗位跟进干系流程管理，占用工时。
再有，文档和产品开拓一样，是一个滚动性流程，须要不断更新迭代。以是，资源投入也是持续性的。
早期的时候，海内很多企业利用人力本钱上风，发起人海战术，将资源集中投入到产品研发上，靠价格上风和版本速率（需求相应速率）抢占市场。
开拓工程师忙着写代码，做版本，哪有韶光去写文档？基本上都是拿产品设计辅导书改一改，截截图，就扔给了售后，乃至扔给了客户。
内部用户（售后）骂娘，领导实在心里有数，毕竟资源有限，只能捐躯文档保版本，对内部反馈进行弹压。而外部客户的见地，是无法进行弹压的。
对付一些低端客户来说，比较关注的是价格。极度的本钱上风，可以让客户忽略文档。但是，对付高端用户来说，他们对文档的哀求和对产品的哀求是同等的。没有精良齐套的文档，一样不给中标。
于是，倒逼设备商投入资源补齐短板，组织人力进行文档专项开拓。结果创造，实在并不是写不出好文档，而是之前没有舍得投入资源。
然而，一旦项目搪塞过去，资源又会撤走，好不容易建立起来的文档质量，又再次垮塌，如此恶性循环。
以是说，对付企业，想要把文档满意度搞好，树立有利于产品品牌的文档品牌形象，关键在于领导愿不愿意投钱。有钱就有人有资源，这是搞好文档的基本条件。
随着市场的规范和成熟，加上竞争日趋激烈，文档的主要性不断提升，越来越多的企业卖力人开始意识到这个问题，不断加大对文档的资源投入。
计策层面的重视是根本，战术层面的实行是关键。
前面说的文档管理体系，是有一整套方法论的。大到文档体系的架构（到底须要多少篇文档，分别由谁来卖力，写给谁看），小到文档内容的编写，都有相应的理论和技巧。这些不是靠人海战术就可以完美完成的。
限于篇幅，我就不详细先容文档管理体系了。我重点说说单篇文档的写作技巧。
想要写好一篇文档，首先第一个问题，便是你要搞清楚这篇文档的定位——它是一篇什么性子的文档？写作目的是什么？它的利用者是谁？
文档的定位，直接决定了整篇文档的基调。
例如我常常写的零根本入门，定位便是对干系内容背景知识毫无理解的读者。然而，又不是小学生那种层次，而是至少已经完成了根本教诲，处于大一及以上学历水平的读者，有基本的物理学和数学知识，也有对自然现场的基本认知，还有正凡人的逻辑思维能力。
如果你写技能文档，首先要搞明白，文档利用者是内部客户还是外部客户，是有履历的客户，还是零根本的客户，是已经阅读过前置文档的客户，还是第一次看这套文档的客户。
明确了工具之后，要牢记，在写作整篇文档的过程中，你都要随时切换自身角色。一定要站在读者的角度，琢磨文档内容是不是能看得懂。
如果没有把握，那么，就找个和目标读者处于同等水平的体验用户，让他试读，供应反馈见地。
大部分技能文档的作者不是作家，乃至不是文科生，而是技能工程师。这类人在笔墨表达技巧上常日比较欠缺，但是有一个显著上风，那便是逻辑思维能力强。对付写作来说，这一点非常主要。尤其是技能文档的写作，必须有很强的逻辑思维能力。
文档的总体构造，必须要有逻辑连贯的章节顺序。文档的语句，也必须有逻辑严谨的表述办法。过于跳跃的思维，不适宜运用于技能类文档。文科生过于感性的笔墨，也不适宜技能类文档。
技能工程师最常犯的毛病，便是自以为是：“这么大略，你怎么都不懂？”“这是根本啊，是个人都懂！
”然后就偷工减料，言简意赅，跳过了大量的细节，忽略了可能涌现的不同情形，让文档利用者不知所措。乃至有的作者，喜好玩“玄学”，以为越写得博识，就越显得自己很懂，切实其实可笑。
规范的技能文档，常日会遵照SOP的原则。所谓SOP，便是 Standard Operating Procedure，标准作业程序。
下面这段内容，是一个SOP文档写作的范例：
大家会看到，前置信息非常充分，该先容的背景，都会先容到位。
详细的操作步骤，虽然简短，但内容十分清晰，分为几个步骤，每一个步骤敲什么命令、有什么目的，都会见告你。
在末了，还会有验证结果环节（本例的验证结果部分相对简单，实际上还该当包括通过命令，查当作果，以此进行明确验证）。
上面这种SOP的文档写作办法，和我们从小接管过的传统写作是完备不同的，
以前我们常说，中式菜谱喜好用“盐少许、酱油少许、大火煎炸少焉”这种定量非常模糊的表达办法，实在确实和我们的写作习气有一定关系。对付技能文档来说，我们这方面的侧重性培养和演习确实做得不足。真正的写作，不是刻意追求辞藻的华美，而是意思和情境的准确表达。
要想写好技能文档，还有一个主要技巧，那便是多用图表。
所谓“字不如表、表不如图”。技能是很抽象的东西，也是理解起来很有难度的东西。想要靠纯笔墨进行内容转述，是很困难的。以是，该当更多地借助表格和图片，乃至gif动图，帮助读者理解。
说白了，这个便是磨练作者的任务心。如果写作者不能站在读者的角度，不能以读者满意度为出发点，那么，就不会乐意多此一举去画图。画图是很繁芜的事情，有时候我写文章，一幅图都要画一天，很不随意马虎。
技能文档的写作，不仅对企业来说非常主要，对付个人来说，也是受益匪浅的。
养成并坚持写作的习气，有利于培养逻辑思维能力，也有利于个人知识沉淀积累。个人可以开技能blog或"大众年夜众号，揭橥并分享自己的履历心得，会很有造诣感，日积月累的话，乃至可能形成个人品牌和影响力，有利于自己的职业生涯发展。
虽然现在视频化的趋势明显，但是我个人认为，文档是无法被视频取代的。目前的技能，视频无法进行快速内容检索，无法进行快速更新和修正，无法进行快速通报，文件体积较大，这些都决定了文档的不可替代性。
视频的上风，更多在于内容形象而生动的展示，可以让用户有更感性的认识，更深刻的影象，适宜培训，不适宜事情查阅，不适宜归档。
好啦，以上便是小枣君关于技能文档写作的分享，希望对大家有所帮助。顺便打个小广告，大家如果有自己以为还不错的技能文档输出，也欢迎投稿给鲜枣教室，稿酬丰硕！
末了，感谢大家的耐心阅读，我们下期再见啦！
