𝗗𝗼𝗰𝘂𝗺𝗲𝗻𝘁𝗮𝘁𝗶𝗼𝗻 𝗜𝘀 𝗔 𝗙𝗲𝗮𝘁𝘂𝗿𝗲
文档不是独立于产品的。它是产品的一部分。
许多开发者遵循一种错误的模式：
- 构建功能。
- 测试功能。
- 发布功能。
- 编写文档。
用户体验不到你的代码。他们体验的是你的界面、工作流和文档。对用户而言，文档就是一个功能。
创造者往往忽视文档，因为他们已经了解了产品。你知道为什么做出某些决定，你知道 API 如何工作，你知道快捷方式。
但用户并不了解。对你来说显而易见的事情，对他们来说却充满了神秘感。
将重复出现的问题视为“文档债”。如果人们两次问同一个问题，说明你出了问题。要么是你的产品令人困惑，要么是你的文档不完整。有时你需要修复 API，但通常情况下，你需要修复文档。
优秀的文档能减少摩擦。它能快速回答这些问题：
- 这是什么？
- 我为什么要用它？
- 如何开始？
- 最佳实践是什么？
- 有没有简单的示例？
目标不在于面面俱到，而在于保持推进的势头。
优秀的文档传达模式和意图。它解释了为什么框架要以某种方式工作。这能让用户更高效。
文档会以一种潜移默化的方式影响你的业务：
- 采用率。
- 上手速度。
- 支持成本。
- 社区增长。
- 开发者体验。
你很难直观地看到优秀文档带来的影响，但你会立刻察觉到糟糕文档带来的问题。
请记住，文档也是为你自己准备的。它为你未来的自己保存知识，记录决策，这样你就不用在几个月后重新寻找答案。
产品质量与文档质量是挂钩的。
- 混乱的软件需要更多文档。
- 清晰的软件需要更少文档。
- 优秀的文档能揭示糟糕的设计。
不要再把文档当作事后才考虑的事情了。利用文档来倒逼清晰度。清晰度提升设计，而改进的设计则能提升产品。
Source: https://dev.to/stinklewinks/documentation-is-a-feature-228n