技术文档写作指南

一、写作载体

二、写作方向

功能简介

三、文档格式

使用说明

应用举例

FAQ

四、文档维护

五、写作好处

（一）、为什么要写文章

1. 复盘学习成果，巩固知识理解
2. 提升思考能力
3. 传播技术知识，积累技术资产
4. 提升表达与总结能力
5. 打造个人品牌，提高影响力
6. 获取额外收入

（二）、对读者的好处

1. 快速获取知识
2. 提高写作技巧
3. 扩展知识边界

（三）、什么是好文章

1. 万字长文，干活满满
2. 俏皮活泼，生动有趣
3. 第一人称，故事开展
4. 逻辑下沉，技术深入
5. 深入浅出，系列文章
6. 热点概念，前言信息

（四）、怎么样去写一篇文章

1. 日常记录和总结
2. 深耕领域技术
3. 源码走读分析
4. 国内外新热文章
5. 读书分享
6. 受众分析
7. 相同技术类别：有足够知识背景，适合使用专业术语深入探索某一个领域逻辑
8. 不同技术类别：有一定知识背景，适合架构分享、项目总结类文章
9. 产品、运营：技术背景相对薄弱，适合深入浅出，科普介绍技术的实现和目的

（五）、收集资料&素材

1. 平时知识储备：平时读书笔记、项目记录，知乎和公众号相关文章的收藏、总结、思考等；
2. 请教该领域的专家，是否有推荐的书籍与资料，当前主题相关知识的挂念要素有哪些，主要挑战有哪些；
3. 善用搜索引擎，必要时间阅读相关领域前沿学术论文期刊，以图获取最可靠专业的技术背景；
4. 保证文章的可靠度、专业性
5. 至少保证专业对齐甚至超出行业领先水平，以提供足够的价值

（六）、确定大纲