| 原则 | 读者导向、结论先行、可操作、可验证 |
|---|---|
| 结构 | 任务型（怎么做）与概念型（是什么）分开 |
| 完善 | 根据读者提问与搜索日志持续补充 |
段落对比示例
段落对比示例
不推荐：本系统采用分布式架构设计，具有…
推荐：重启服务前先摘除流量。命令：
systemctl stop app && systemctl start app技术写作要点
技术文档服务读者完成任务：先写结论与直接可执行的路径，再补背景与原理；面向对象与前置条件明确，示例可复制可验证；一件事说清楚，胜过面面俱到。
易错点
- 写作自嗨：堆砌设计与历史，读者找不到操作步骤
- 只写概念不写任务：读者知道是什么，仍不会做
数据来源与参考
- 技术写作公开资料（《Docs for Developers》、Write the Docs）