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综合练习

用户研究与选题

Persona、Buyer Journey、Support 工单。

30 分钟

用户研究与选题

写没人要的文档是浪费。技术写作者要像分析师一样 听用户、看数据、跟发布,把文档 backlog 排优先级。

学习目标

  • 运用 Persona 与 Buyer Journey 理解文档读者
  • 从 Support 工单与搜索日志提取选题
  • 建立文档需求 brief 与优先级框架

核心概念

读者 Persona

Persona目标文档偏好
后端集成者调通 API、上线Reference、Quickstart
课程运营批量维护内容How-to、Admin 指南
开源贡献者提 PR、本地跑CONTRIBUTING、Architecture
技术决策者评估是否采用Overview、Security、SLA

同一功能 often 需要 多 Persona 多入口,而非一篇万能长文。

Buyer Journey 与文档

Awareness — 什么是 CodeRoadMap API(Landing、Concepts)
Consideration — 对比自建 CMS、集成成本(Guide、Case)
Decision — Auth、定价、合规(Trust、Policy)
Onboarding — Quickstart、SDK
Retention — Changelog、Migration、Advanced

文档应覆盖 决策前焦虑(安全吗、稳定吗)与 上手前焦虑(要多久、要什么环境)。

Support 与搜索信号

  • 工单聚类:同一错误码出现 20 次 → Troubleshooting
  • 站内搜索零结果:直接选题
  • 文档页高跳出低时长:结构或前提条件有问题
  • Release 前:新字段、Breaking change 必写

选题 Brief 模板

问题 — 用户卡在哪、影响谁
证据 — 工单链接、搜索词、Slack 线程
交付 — 页面类型、Owner、截止日期
成功 — 工单下降 X%、搜索命中、Review 通过

练习

  • 为「tracks API 集成者」写半页 Persona
  • 从 3 条 mock Support 工单提炼 1 个 Troubleshooting 选题
  • 填一份文档 Brief:主题「OAuth 接入」

小结

好选题来自真实 friction;Persona 与 Journey 决定写什么、写多深。 下一课看 CMS、查重与链接追踪等发布工具。

加载本节练习…
← 上一课
写作结构与风格
下一课 →发布与协作工具