2024-08-04, 13:40–14:10 (Asia/Taipei), TR412-1
Diátaxis 是一種關於文件的思考和實施方式。
它根據系統地理解文件用戶的需求，規定了內容、架構和形式的處理方法。
Diátaxis 確定了四種不同的需求，以及四種相應的文件形式——教程、操作指南、技術參考和解釋。它將它們放在一個系統的關係中，並提出文件本身應圍繞這些需求的結構進行組織。
Diataxis 所服務的使用者是某個技能領域的從業人員. 技能領域是由工藝定義的 - 工具或產品的使用就是工藝
使用程式語言是一門手藝, 就像駕駛一輛特定的飛機, 甚至成為飛行員一樣.
Diataxis 解決了文件內容(寫什麼), 風格(如何寫), 和架構(如何組織)相關的問題
Agenda
- Introduce to Diataxis[5mins]
- A map of the territory of craft
> 解釋 Distaxis 理論中的兩個維度, Action/Cognition 和 Acquisition/Application
> 和解釋什麼是不好的文件品質
- A map of the territory of craft
- Types of the documents[10-15mins],
> 在這邊我們會以 Kubernetes Documentation | Kubernetes 和一些生活中的類似例子(烹飪和遊戲)配合四種文件類型
> 為範例去解釋如何應用這樣的架構,- Tutorial
- 對應烹飪中的烹飪課和遊戲中的新手教學
- How-to guides
- 對應烹飪中的食譜和遊戲中的過關攻略
- Reference
- 對應烹飪中的包裝訊息和遊戲中的角色技能數值設定
- Explanation
- 對應烹飪中的食材理論和遊戲中的核心概念和深層次設計
- Tutorial
- More concept[3-5 mins]
- How to use Diataxis?
- 如何發展良好的文件結構?
- Tutorials and How-to guides
- Reference and Explanation
- How to use Diataxis?
- QA[~mins]
jneo8 is a engineer focus on cloud technology and love open source world.