技术写作的棘手挑战

主要观点:技术写作存在一些公认的棘手挑战,如完整性(难以及时全面记录所有新功能及满足用户所需各类文档)、正确性(系统变化时难以保持文档与系统新现实同步)、发现性(即便所需内容存在,也难保证用户能找到),这些挑战用 2010 年代的实践和技术无法解决,需将新工具和实践融入 2010 年代的基础,作者写此帖是想听听同行意见,且不提出具体解决方案。
关键信息:

  • 提到了 Riona McNamara 和 Aaron Gillies 讨论过这些棘手挑战。
  • 指出“discoveryness”是个玩笑,真正应是“discoverability”,并引用 Strunk & White 的观点。
    重要细节:详细阐述了每个挑战的具体情况,如完整性方面难以全面记录新功能和提供所需文档,正确性方面系统变化时难保持文档同步等。
阅读 12
0 条评论