✍️ 技术写作 & 文档工程

好的文档 = 免费的增长飞轮。从框架选型到写作风格,系统化构建让用户爱不释手的技术文档

$10M+
Stripe 文档年 SEO 价值
3.5×
好文档的 Fork 转化提升
5
专题页面

🎯 为什么技术写作是 SaaS 的核心竞争力

Stripe 凭什么成为开发者首选支付 API?不是因为技术最好——Braintree 也不错。是因为 Stripe 的文档体验碾压级别的领先。当开发者 Google "how to integrate payment",Stripe 的文档永远排第一。这个自然搜索流量,按广告价值计算每年超过 $10M。文档不是成本中心——是增长中心。

📚 专题目录

🔧

文档框架对比

Docusaurus vs Mintlify vs Nextra vs GitBook vs Notion——各适合什么场景、成本、部署方式

DocusaurusMintlifyNextra
🔌

API 文档

OpenAPI/Swagger 自动生成、Zod→JSON Schema、Try It Out 交互式文档、认证示例、错误码文档

OpenAPISwaggerZod
🎓

教程设计

5 分钟 Quick Start 法则、渐进式教程结构、可复制粘贴的代码块、从零到 Hero 的学习路径

Quick Start渐进式学习路径
📋

Changelog

Keep a Changelog 规范、Conventional Commits 自动生成、Release Tweet/Thread 模板、用户可订阅的更新

Keep a ChangelogConventional Commits
✏️

写作风格

技术写作的 10 条规则、主动语态、短句、代码>文字、避免 jargon、中文技术写作的特殊注意点

写作规则中文技术写作

🔗 关联知识库

📢

开源项目运营

文档即增长——开源项目的文档驱动增长策略

💰

定价案例库

Stripe 等产品的定价与文档策略