宏伟统一的文件理论

2021-04-16 04:17:56

Diátaxis框架旨在解决技术文档结构问题。它采用SystematicApproach,以了解文档用户的需求与产品的互动循环。

这些模式(或类型)对不同用户需要的答案,满足不同的目的,需要不同的东西。

换句话说,我们称之为文档的根本不是一件事,而是四个。了解这一含义将有助于改善大多数文档 - 通常是非常普遍的。

Diátaxis承诺使文档和项目更好,以及与他们一起工作的团队更成功。

在重新设计CloudFlare开发人员文档时,此内容FrameworkBecame我们的北星进行信息架构。当我们不确定新的内容应该融合时,我们会咨询框架。我们的文档现已更清晰,读者和共同之处。

该框架是轻量级,易于理解和简单申请。它不会施加实现。

Diátaxis提供了全面且近似普遍适用的方案,在实践中已被证明是各种各样的领域和应用。这些包括大而小,开放,开放和专有的文件项目。

如果您更愿意观看涵盖此主题的视频,请(由Pycon Australia 2017提供)。