/note/tech

2021年11月19日号 「Diataxis」ベースのドキュメントへの移行宣言,OpenSSL3トランジション:Ubuntu Weekly Topics

Ubuntu本体そのものとは少し性質が異なるものの,興味深い宣言がCanonicalから出されています。この宣言は端的には,「⁠今後,CanonicalでのドキュメンテーションはDiataxisフレームワークを用います」というものです。

Diataxis(注1)はドキュメントをExplanations(解説; 理解のための詳細なドキュメント⁠)⁠・How-to guides(特定のタスクを解決する例⁠)⁠・Tutorials(初心者が最初に始める習得の起点⁠)⁠・Reference material(参考資料; 定義や動作を示すもの)の4つに分類して整理する思考フレームワークを含む文書化技法で,MAASのドキュメントでは先行して展開されています。

ふむ。