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