用户导向

技术文档中应该以用户为导向。为编写出可用性较高的文档,文档作者应尽量站在用户的角度思考问题。具体要求有:

  • 文档作者应充分考虑文档受众的技术水平分布以及实际操作中可能出现的问题,尽可能全面、清晰地将技术信息普及给大众。

  • 对于操作型技术文档,除语言审校外,建议继续进行“文档可用性测试”——由一位无技术背景的测试人员参照该文档进行完整操作,如操作顺利成功,则该文档可用性测试通过;如失败,则需要继续修改完善文档。

案例

欢迎各位 TW 们补充你身边的案例。