用户导向#

技术文档应以用户需求为核心，遵循以下实践原则：

1. 用户分层适配

   • 充分考虑读者群体的技术水平差异（新手/专家），采用分层式内容设计

   • 示例：在API文档中区分快速入门（基础调用）和高级配置（参数调优）章节

• 对于操作型技术文档，除语言审校外，建议继续进行“文档可用性测试”——由一位无技术背景的测试人员参照该文档进行完整操作，测试结果判定标准：

  • ✅ 成功：测试人员独立完成所有操作

  • ❌ 失败：记录卡点步骤并召开复盘会议

• 对于操作型技术文档，不仅要准确描述操作步骤，还应设身处地考虑用户可能面临的问题，提供进一步的详细信息。例如，对于需要输入的信息，提供输入格式等详细要求；对于报错信息，提供解决报错的可选操作；为方便用户排查错误，需提供标准化的错误码速查表：