jneo8
jneo8 is a engineer focus on cloud technology and love open source world.
Sessions
08-04
13:40
30min
使用 Diataxis 建構高質量技術文件
jneo8
Diátaxis 是一種關於文件的思考和實施方式。
它根據系統地理解文件用戶的需求,規定了內容、架構和形式的處理方法。
Diátaxis 確定了四種不同的需求,以及四種相應的文件形式——教程、操作指南、技術參考和解釋。它將它們放在一個系統的關係中,並提出文件本身應圍繞這些需求的結構進行組織。
Diataxis 所服務的使用者是某個技能領域的從業人員. 技能領域是由工藝定義的 - 工具或產品的使用就是工藝
使用程式語言是一門手藝, 就像駕駛一輛特定的飛機, 甚至成為飛行員一樣.
Diataxis 解決了文件內容(寫什麼), 風格(如何寫), 和架構(如何組織)相關的問題
Miscellaneous Open Source Topics
TR412-1