前语
咱们为什么要写技能文章呢？在作业中怎么沉积出技能文章呢？怎么写好一篇技能文章呢？信任经过这篇文章你能够得到答案。那么咱们开端吧。
写作前的作业
1. 写作价值
1.1. 传递和共享技能
前人栽树，后人乘凉。 在日常开发和运维作业中，开发人员往往会借助很多的手法学习、剖析、处理问题，比方：官方文档、开源社区、技能博客和公司内部论坛等。
经过写作技能文档、技能文章，能够在技能圈子传递和共享自己对一个技能的 认知 和 经历总结，接受反应、彼此学习，加强对技能的讨论和进步。经过别人技能文章处理问题的一起，咱们也应该学会 反哺。
1.2. 打造个人影响力
一篇实用的技能原创文章，能够为自己带来很多的读者，能够开掘和进步个人包含技能在内的才干，大幅提升个人的 影响力。
- 写作好的技能文章能够进步自己在 职业、公司内部 的影响力，为职业或公司 沉积常识体系。
- 持续输出高质量的文章能够 打造个人流量，协助别人的一起 获取流量 和 常识付费变现。
1.3. 进步个人总结才干
写作对个人的专业水平和综合才干是有必定的门槛的。正所谓技多不压身，除了根本的编程开发才干，开发人员还应该具有一些其他技能：
- 技能学习才干：擅于学习新的技能，总结规则、构成自己的学习体系和常识库，对任何新技能都能快速上手、举一反三和融会贯通。
- 文档沉积才干：学而时习之，因为技能和常识体系过于庞大，需求定期进行总结和归纳，构成自己的常识备忘录，加深对技能的了解。
- 问题排查才干：将线上疑难杂症的剖析处理才干以文档、博客的方式总结，便利后续遇到同类问题时能够快速剖析、定位和处理。
2. 写作妨碍
2.1. 从0到1：从没写过到写过
万事最初难，技能写作也是一样，一般迈出第一步是最难的，这个阶段的中心是 打破自己内心的妨碍。这时的妨碍首要来自两方面：
- 个人内容方面：忧虑自己的文章 描述有误、内容不足 以及 深度不行。
- 别人观念方面：忧虑比自己厉害的人笑话自己写的 文章不好，无法解答别人提出的 疑问。
有这两方面忧虑很正常，当然这两方面的忧虑其实也都好处理。
- 个人内容问题：
明确定位文章的 面向群体，面向初级、中级、高档、TL 仍是技能总监，内容高度是有很大区别的。不同岗位、不同职级的人本身对 文章层次 的需求相差甚大，并不是高度越高就越好。
- 别人观念问题
必定有很多比咱们厉害的人，那么这些人会带着什么心态去看这些文章呢？
首要能够明确不是带着批评的心态，其次他们或许也期望经过文章去弥补自己，看看是否有新观念、新主意的出现。即使不符合他们的胃口，比方讲的内容自己或许做得更好，他们会很快关闭去看其他的，而不是持续浪费时刻。当然，还有一种或许，他们或许并 不会翻开。总归，这方面也没有什么可顾忌的。
2.2. 从1到N：从不想写到自动写
迈出第一步之后，接下来这个阶段的中心是 持续堆集、总结 和 输出。
不积跬步无以至千里。要写出 高质量 的文章，需求不断地 堆集资料 和 总结经历，最终经过文字表达出来。先说下堆集和总结，这个分 堆集资料 和 体系总结：
- 堆集资料
在日常学习和作业中，要养成 记录漫笔 的习惯，随时记录一下自己对技能的了解和考虑，也包含作业实践中的 踩坑避雷 的经历总结。这个进程不限于 阅览、收藏 别人的好文章、提炼 出中心的 技能常识点，并对资料和常识点进行 标记 和 归类。
- 体系总结
当某项技能的收藏和记录 常识资料 堆集到必定程度时，你对技能的 了解 和 认知 也会到达必定的 广度 和 深度。当你在作业中 运用到 这项技能，将理论基础和实践中的 技能计划、技能调优 和 数据支撑 相结合，融入工程化实践和自己的观念，最终将常识 结构化 和 文档化，就构成了一篇 高质量 的文章。
3. 写作内容
在日常作业中哪些内容能够沉积为技能文章，咱们得先清楚 哪些内容 是能够产出技能文章。
3.1. 线上毛病和处理经历
你遇到过的线上技能问题和难题，一般是某个具体的技能点（bug、功能、生产事端等），经过你的 剖析、排查 和 处理，问题得到了 有用处理，处理后你又 体系性地 学习和研究了相关技能常识，即可总结为一篇文章。
3.2. 规划计划和东西介绍
你在作业中为处理某个 事务问题，经过 剖析、调研 和 验证 等环节，产出的 规划计划，及其运用到的相关 东西、结构 或 组件 等，可总结为一篇文章。
3.3. 新技能和新趋势介绍
你重视的职业发展中出现的 新技能、新趋势，能进步处理问题的 效率、带来更好的 实践 或能够有用打破现有技能的 瓶颈 等，可总结为一篇文章。
3.4. 项目遇到的应战和处理计划
你参加过的某个项目，为了 按时高质量 的交付，遇到的一些应战（问题、风险等），可所以 技能方面 的应战，也可所以 沟通协作 的应战，或者是 作业方式 的应战，都能够总结出经历和教训。
3.5. 好用的开发东西和运用技巧
你在写代码、调试、测验和运维等阶段，发现了好用的 东西、技巧 或 规范，能够进步 作业效率、代码质量 等，也可总结为一篇文章。
3.6. 编程言语和结构的实践经历
你学习的 编程言语、技能结构 的学习笔记（整理、总结 等）、实践经历（Demo 代码、实践运用），可总结为一篇文章。
4. 写作途径
好记忆不如烂笔头，写作不是一个作者的专职作业，日常作业和学习有很多锻炼的方式，关于程序员来说有哪些方式呢？
4.1. 写代码注释
在日常开发作业中，写好代码注释也是一种好的手法。假如你的代码写得足够优异，是不需求过多注释的，注释是对代码的一种了解的增强。
关于 杂乱事务场景、公共代码库 以及 不流畅难明 的代码，明晰的注释能够协助其他开发人员快速了解 事务上下文 和 代码逻辑。
什么是好的注释：
- 注释应当 简短、精粹 和 明晰，防止长篇大论的阐明论说。
- 告知咱们你 “为什么” 写这个注释，而不是 告知咱们这段代码 “是什么” ！ “是什么” 应该交给代码本身去解说，这个最为要害。
- 注释有 时效性，持续维护 你的注释，也便是记得及时更新，与当下 代码语境 匹配。
4.2. 答复技能问题
- 回复简书、、知乎、51CTO、CSDN、博客园和思否等渠道上别人提出的问题。
- 在 Github、Stack Overflow、官方技能渠道等渠道提出、答复问题。
- 在公司内部技能论坛、其他团队的技能文档下提出问题。
- 在内部代码检视时和 Pull Request 时给予合理的评论。
4.3. 写技能博客
- 在微信大众号、简书、、知乎、51CTO、CSDN 和博客园等渠道宣布技能文章。
- 在 InfoQ、51CTO、阿里开发社区等官方技能渠道刊登杂志、技能博客。
- 定制自己的技能博客网站，经过内容品质、站点运营推广自己的技能文章。
- 注册个人常识星球圈子，将个人技能文章进行沉积、收拾和归档。
- 在公司内部技能论坛、技能博客宣布技能博客，包含内部技能和开源共享。
4.4. 写技能文档
- 利用 Gitbook、Docsify、VuePress 和语雀对某个技能领域进行长时刻的常识沉积。
- 在公司内部 Confluence Wiki、WPS 文档和公司代码库房编写技能文档。
4.5. 写技能书本
对某个技能领域有了深化和体系的学习、了解和考虑，有了 成系列 的技能文档、技能博客今后，就能够考虑出书技能书本的或许。
假如需求出书技能书本，要先了解市面上同类书本的内容，确定出书书本 针对的方向、侧重点、独特性。首要的出书社如下：
- 图灵出书社
- 机械工业出书社
- 人民邮电出书社
- 电子工业出书社
- 清华大学出书社
5. 写作东西
俗话说得好，工慾善其事，必先利其器。最终共享一下不错的文章写作东西。
5.1. 画图东西
ProcessOn
ProcessOn 是一款专业强壮的作图东西，支撑 多人实时在线协作，能够用于在线制作 流程图、思维导图、UI原型图、UML图、网络拓扑图、安排结构图 等。ProcessOn 只能支撑 9 张免费在线图片存储，支撑多种格式的图片文件 导入导出，能够兼容不同的操作体系，不管是 Mac 仍是 Windows，一个 浏览器 就能够完成画图作业。
- 价值链图（EVC）
- 常规流程图（Flowchart）
- 工作进程链图（EPC）
- BPMN2.0 图
- Venn 维恩图
- Org 安排结构图
- iOS 线框图
- UI 页面原型规划图
- UML 一致建模言语
- 高端时序图
更强壮的功能，支撑多规范的格式交换：
- 支撑将 Visio 图转换成 ProcessOn 文件
- 支撑将 BPMN2.0 文件转换成 ProcessOn 文件
- 支撑将 ProcessOn 的 BPMN 图导出成 BPMN 格式文件
- 支撑将 ProcessOn 的图导出成开放格式的 pos 元数据文件等
Draw.io
Draw.io 是一个很好用的 免费流程图 制作东西。
你能够利用它制作一系列的图表、图示或图形，包含 流程图、UML类图、安排结构图、泳道图、E-R图、文氏图 等，适用于商务、工程、电气、网络规划、软件规划等诸多领域的专业绘图。它致力于成为 完全开源、免费、而且高质量的绘图软件。
软件内置了适当丰富的绘图资源，包含各类形状、图标、连接器、模板，能满意绝大大多数的绘图需求，还能够导入第三方图标资源满意更多需求，完全能够替代微软 Visio 等流程图软件。
Excalidraw
Excalidraw 是一款十分轻量的在线白板东西，能够直接在浏览器翻开，轻松制作具有手绘风格的图形。Excalidraw 依据 Markdown 语法完成绘图功能，不只 简洁轻量，还能够和 Markdown 编辑器的东西集成，完成各种特征功能。
与 Visio 绘图比较，在 Obsidian 东西中运用 Excalidraw 绘图的优势体现在：
- 依据 Markdown 语法创立绘图，源文件简洁轻量。
- 图形源文件完美嵌入 Obsidian 笔记，支撑随时编辑修正。
- 灵敏的个性化设置，完成创立、编辑、办理、共享图片一气呵成。
- 手绘风格新鲜高雅。
5.1. 图片渠道
好的文章需求好的封面，有条件的能够自己画，也能够用一些东西来生成，比方 创客贴、稿定规划 等，也可所以恣意的图片。
创客贴
创客贴 是一款简略易用的 线上图形规划神器，功能十分强壮，涵盖了新媒体营销、大众号运营、广告印刷、作业文档、电商、日子等多个场景。
稿定规划
稿定规划 是一款专为电商运营者、新媒体运营人员和作图爱好者打造的在线智能化平面规划东西。经过 简略拖拽 操作，一分钟即可轻松搞定不同场景不同尺寸的各种规划。
写作中的作业
1. 创立纲要
安排文章的 结构 和 内容，其间的 结构 是指文章的 结构安排方式，内容 更多的是指 内容纲要。
1.1. 整理写作结构
有了好的内容，还要留意文章的结构。关于结构，有一本书叫 《金字塔原理》。金字塔原理教训咱们在写作、表达的时分，要构建 明晰的结构。
关于一篇文章来说，金字塔的顶点是 中心观念，即一般便是文章的标题。围绕着这个 中心观念，咱们能够用 多个观念 去支撑中心观念。假如表达的内容很多，观念还能够进一步 往下细分。构成一个 以上统下、逻辑递进 的金字塔结构。
经过这种方式写出的文章，就会显得逻辑明晰，结构紧凑。
关于技能文章来说，能够考虑运用 3W2H模型 来 构建结构。比方要写一篇关于 笼统才干 的文章，就能够经过以下角度去说：
- What：什么是笼统。
- Why：笼统为什么重要。
- How：怎么进行笼统.
- Where：笼统能够用在什么地方。
- How much：笼统到什么程度。
分外提一点，文章的 最初 和 完毕 要同样是比较重要的，不要忽视。
- 要有引进入胜的最初
概述文章的主题，能够做到招引读者的留意力，一般能够经过提出问题、叙述一个引人注目的事实或相关的故事。
- 在文章最终要有总结
首要是总结文章的首要观念，重申你的观念，提供进一步的建议和行动指南。
1.2. 选择安排结构
需求依据文章的主题和目的选择 适宜 的安排结构，以便让读者更简单了解。常见的技能文章安排结构如下：
问题处理结构
依照 一个 或 多个问题 来安排，然后经过提供 处理计划 来答复这些问题。这种结构的文章一般适用于 技能教程、处理问题 的指南和操作阐明等。
过程性结构
依照一系列过程或操作来安排，以便读者能够 跟随过程 完成任务或操作。这种结构的文章一般适用于 技能教程、操作阐明 和 编程教程 等。
剖析性结构
依照一系列 概念、理论、办法 或 技能 进行剖析和解说，以便读者能够更好地了解 技能原理 和 运用场景。这种结构的文章一般适用于 技能剖析、技能评估和比较 等。
项目式结构
依照一个完好的项目或任务来安排，以便读者能够了解整个项目的 完成进程 和 技能细节。这种结构的文章一般适用于 项目开发 和 技能计划完成 的介绍。
阐明性结构
依照一系列 技能概念、术语 和 技能 等进行解说和阐明，以便读者能够更好地了解 技能常识 和 运用场景。这种结构的文章一般适用于 技能介绍 和 技能文档 等。
1.3. 确定内容纲要
内容纲要是依据文章的安排结构、主题和方针确定的，以下是一些建议：
列出骨干部分和子部分
依据主题和方针确定文章的 骨干部分，及其 子部分，协助你理清 内容结构 和 思路，确保能够覆盖到主题的各方面。
确定各部分的首要内容
关于每个首要部分和子部分，进一步 拆解，确认它们的 首要 和 重点内容。
编排各部分的逻辑次序
依据文章的主题和方针用户，选用适合的次序 安排 各个部分，使其有更好的可读性和连贯性。
备注注释和细节
在内容纲要中，结合收集到的信息和文章思路，添加一些重点的 注释、细节，以便在写文章时，不会留传一些重要的细节和思路。
2. 安排文章
依照文章的提纲，开端写文章。为了让读者易读、易懂，要做到 明晰地安排文章，以下是一些建议。
2.1. 言语简洁明了
- 不要运用杂乱的语法、词汇、行话，尽量运用 短句，一句话要控制在 40字 以内。
- 尽量不要用 长阶段，大约 3~5行 就需求另起一段了。
2.2. 运用阶段和分层
- 多选用 标题 和 小标题，凸显出内容层次和主题聚焦度。
- 每个标题内选用 阶段，每个阶段的 最初放主题句。
- 阶段内 选用 迭进次序，可依照 时刻次序、逻辑次序、重要性次序 等
- 多选用 列表，可所以有序列表或无序列表，让 逻辑条理愈加明晰。
2.3. 运用辅佐图表和示例
在阐明观念、概念的一起，辅佐图表、插图、数据、示例（实践的案例、含注释的代码等）愈加 直观吸睛，让人觉得更有 说服力。其间可视化相关的 图表、插图 和 表格 等是特别高效和受欢迎的。
2.4. 删去不必要的内容
在确保内容完好性的基础上，内容 越简炼越好。写文章和复审时，要有意识地只保存与 主题相关 的信息，如不运用 不必要 的形容词、副词等，专注于中心内容，不做额外修饰。
2.5. 防止重复词汇
总是 重复 的词汇、观念，会让读者感到 低效 和 枯燥，因此需求防止，可运用一些 近义词替换。
2.6. 注重细节和准确性
- 假如有引证，要有 参考资料 和 链接（参考资料最好有必定的权威性和准确性）。
- 不要有 错别字，越是细节越要留意准确性，这样会让读者感觉到专业、精品。
- 假如是 中文写作，请必须用 中文标点。
2.7. 留意排版和格式
- 运用适宜的 字体、字号 和 间距。
- 文章中的 重点观念 和 要害词 能够着重 加粗
- 留意分段讲解，留意标题、阶段和层次结构。
- 规范、易阅览 的示例代码、引证、图片的 表达款式。
- 为了削减在调整格式上花费很多的时刻，推荐选用 Markdown 文档。
2.8. 确保逻辑环环相扣
环环相扣 是指内容不要一下子全讲完，要留下一个 信息缺口 和 层层递进，承上启下 引出下一部分内容，直到文章最终再构成 完好闭环。 从标题开端就要留信息缺口，引起好奇心，招引读者持续往下读。
总结
到此，文章行将完毕，让咱们回忆下文章最初提到的三个问题：
- 咱们为什么要写技能文章呢？咱们知道到了写技能文章的好处。
- 在作业中怎么沉积出技能文章呢？咱们知道了能够写什么、什么时刻能够写。
- 怎么写好一篇技能文章呢？咱们知道了具体怎么写好一篇文章，里边有一些要害点、细节需求留意。
信任你或多或少地得到了一些答案。本文只是做了一个引导，实践出真知。要写好一篇技能文章，需持续不断地 强化练习，才干 下笔如有神。
