技术写作者是什么

技术写作者（Technical Writer） 把产品、API、架构变成开发者与用户能读懂的文档与教程。CodeRoadMap 主栈是 MySQL + Spring Boot；本 track 帮你建立文档思维，与 /roadmaps/technical-writer 路线图对齐。

学习目标

• 区分技术写作者、开发者、DevRel、产品经理
• 理解常见文档类型及其读者
• 明确技术写作者的日常产出与协作对象

核心概念

技术写作者 vs 相邻角色

角色	核心问题	典型产出
技术写作者	用户如何正确、高效地使用	教程、Reference、Release Notes
开发者	功能如何实现	代码、设计文档
DevRel	开发者如何被触达与留存	演讲、示例项目、社区
产品经理	做什么功能、为何做	PRD、路线图

后端维护 POST /api/tracks 等接口；技术写作者关心 Quickstart 能否 10 分钟跑通、错误码是否可查、版本变更有无说明——读代码与产品意图，而不是自己写业务逻辑。

文档类型谱系

入门 — Getting Started、Quickstart、Concepts
操作 — How-to、Tutorial、Cookbook
参考 — API Reference、CLI、配置项
维护 — Release Notes、Migration Guide、Deprecation
支持 — FAQ、Troubleshooting、Known Issues

每类文档回答不同问题：「是什么」→「怎么做」→「查什么」→「变了什么」→「出错了怎么办」。

技术写作者日常

• 与工程、产品对齐功能边界与发布节奏
• 读代码、跑示例、复现用户路径
• 写草稿、走 Review、维护版本与链接
• 看 Support 工单与搜索日志，补文档缺口

与路线图的关系

• /roadmaps/technical-writer — 本 track 主路线图
• /tracks/devrel-essentials — 社区与内容分发
• /tracks/product-manager-essentials — 理解需求与优先级

练习

• 用一句话向非技术人员解释「技术写作者做什么」
• 打开 /roadmaps/technical-writer，找到 API Docs / Style Guide 相关节点
• 为 CodeRoadMap 的 tracks API 设想 3 类文档（入门 / 参考 / 排错）

小结

技术写作者让复杂系统「可被正确使用」；工程保实现，文档保可发现与可理解。 下一课进入 Markdown、Git 与编辑工具。