Community寫作與編輯github.com

diodesign/diosix-agent-skills

編寫與更新 Diosix 文件時的規則、風格標準與受眾指南。在撰寫新文件、更新 CLI 或架構文件,或根據 docs/style-guide.md 審核文件時啟用此技能。

diosix-agent-skills 是什麼?

此技能旨在確保 Diosix 專案中所有文件(docs/ 與 README.md)與實作程式碼(hypervisor/、tools/、scripts/)保持 100% 同步,並嚴格遵循 docs/style-guide.md 的風格規範。它強制執行五項核心要求:使用清晰正確的美式英語、確保文件內容與程式碼變更即時對應、針對使用者與開發者兩種不同受眾設計、嚴格遵循 80 欄換行、主動語態、句子式標題等風格規則,以及在不確定時向主要維護者釐清。此技能支援 Claude Code、Cursor、Codex 等 AI Agent 平台,透過參考風格與術語指南、雙重受眾與文件結構指南等文件,引導 AI 生成符合標準的技術文件。實現方式包括在每次程式碼變更時同步更新文件、使用基礎檔名作為連結文字以保持整潔,以及確保縮寫第一次使用時全稱展開。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/diodesign/diosix-agent-skills/tree/HEAD/documenting-diosix

Installed? Explore more 寫作與編輯 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

撰寫 Diosix 文件

docs/ 與 README.md 中的每個文檔頁面必須與 hypervisor/、tools/ 與 scripts/ 中的實作保持 100% 同步,並須遵守 docs/style-guide.md 的規範,以確保文檔在第一次審查時即通過 reviewing-diosix。

核心要求

  1. 清晰正確的英文散文(基本門檻):所有文檔必須使用美式英語撰寫,拼寫正確、語法嚴謹、措辭簡潔,且絕不犧牲技術清晰度或精確性。
  2. 文檔真實性:切勿在 docs/ 中遺留過時的 CLI 標誌、SBI 函式識別碼、ioctl 編號、C 結構體佈局(uint64_t 對比 unsigned long)、檔案路徑或配置鍵。任何改變行為、CLI 選項、模組化檔案路徑或配置綱要的程式碼變更,必須在相同變更中同時更新 docs/。
  3. 雙重受眾設計:明確針對兩個不同的受眾群體:
    • 使用者(初學者與專家):啟動 Diosix、執行導覽、使用 dsx 啟動客戶虛擬機,或配置宣告式系統/特許清單的操作人員。
    • 開發者與維護者:建置、測試、除錯與擴展 M 模式虛擬機監視器、S 模式 dynarec 與 U 模式工具的工程師。
  4. 嚴格風格合規(docs/style-guide.md):
    • 每行散文、清單項目與程式碼區塊應**<= 80 個字元**(markdown 表格行與長 URL 除外)。在 markdown 連結文字中使用檔案基礎名稱([S50dropbear](../tools/.../S50dropbear)),使連結行能乾淨地換行於 80 欄內。
    • 使用主動語態與現在式(「虛擬機監視器驗證 GPA」,而非「GPA 將由虛擬機監視器驗證」)。
    • 使用句子式標題(## 階層式客戶機模型,而非 ## 階層式客戶機模型)。
    • 縮寫在每頁首次使用時全稱展開(監督器二進位介面 (SBI)),之後僅使用縮寫(SBI)。
    • 嚴格使用編號清單表示順序性的多步驟程序,使用項目符號清單表示非順序性的項目。
  5. 不確定時停止並詢問主要維護者:若預期行為、術語或受眾範圍不明確,應停止並向主要維護者釐清,而非猜測或編造細節。

重點參考指南

在起草或編輯文檔前,請閱讀相關參考檔案:

  • 風格與標準術語:英語語法/拼寫標準、80 欄換行、縮寫展開規則,以及標準硬體/虛擬化定義(主機建置機器、主機硬體、目標平台、HPA、GPA、GVA、CID)。
  • 雙重受眾與文件地圖:針對初學者/專家使用者與維護者調整內容,將程式碼變更對應到特定的 docs/*.md 檔案,並記錄測試慣例。

Individual skills in this repo

This repo contains 2 individual skills — each has its own dedicated page.

相關技能