CodeRoadMap
首页路线题库资源库文章社区
CodeRoadMap

程序员的学习成长路线图。内容免费开放,登录后可同步路线图与课时进度。

由 程序员柏风 独立维护 · 关于作者

学习

  • 路线图
  • 课程
  • 面试题
  • 文章
  • 我

更多

  • 资源
  • 社区
  • 关于作者
  • 内容说明

© 2026 CodeRoadMap

津ICP备2026012044号-1·津公网安备12011002026155号·coderoadmap@126.com
技术写作入门/课时/职业成长
RawBlame
课时目录12 节

技术写作入门

  1. 01技术写作者是什么
  2. 02核心技能与工具
  3. 03文档与内容类型
  4. 04SEO 与关键词
  5. 05写作结构与风格
  6. 06用户研究与选题
  7. 07发布与协作工具
  8. 08API 文档
  9. 09内容营销漏斗
  10. 10分发与外链
  11. 11职业成长
  12. 12综合练习

职业成长

技能进阶、社区、Portfolio。

25 分钟

职业成长

技术写作路径从 Junior → Senior → Lead / DevRel 交叉。证书不如作品集直观;社区贡献与 measurable impact 是进阶筹码。

学习目标

  • 了解技术写作者常见职业阶梯与转岗方向
  • 建立 Portfolio 与 writing samples 的构成
  • 掌握社区参与与持续学习的习惯

核心概念

职业路径

Junior Technical Writer — 单篇 How-to、编辑反馈
Technical Writer — 模块 Owner、API Reference
Senior / Lead — 信息架构、Style Guide、跨团队规划
  → Documentation Manager
  → Developer Advocate / Product Marketing
  → Product Manager(强 domain 背景时)

开源与初创常 一人多角:写 + 发布 + 支持 + 轻度 DevRel。

Portfolio 要素

作品展示能力
Quickstart(可跑通)用户路径、测试意识
API Reference 节选结构化、完整性
Troubleshooting 案例工单驱动、同理心
Style Guide 片段规范思维、协作
Before/After 改写编辑与信息架构

公开 GitHub samples 或 脱敏 PDF;面试时讲 指标(工单降 X%、搜索命中)。

技能进阶

  • 浅码能力:读 Java/Spring、跑 Docker、懂 CI
  • 工具链:OpenAPI、Docusaurus、Vale、Git
  • 数据:文档 analytics、搜索词、A/B 标题(与 PM 协作)

社区与学习

  • 参与 Write the Docs、本地 Technical Writing Meetup
  • 跟 /roadmaps/technical-writer 补缺口节点
  • 读 Google Developer Documentation Style Guide、Microsoft Writing Style Guide

练习

  • 列出 Portfolio 还缺的 2 类 samples 及补齐计划
  • 用 STAR 法则写一段「改进某 API 文档」的项目经历
  • 在 /roadmaps/technical-writer 标记 3 个下季度学习目标

小结

职业靠可验证的文档 impact + 作品集;社区与路线图保持续进阶。 下一课综合练习:为 REST API 写 Quickstart + FAQ。

加载本节练习…
← 上一课分发与外链
下一课 →综合练习