內容創作
docs-applying-content-quality avatar

docs-applying-content-quality

標準化 Markdown 內容,包含主動語態、精確的標題層級以及符合 WCAG AA 無障礙標準,適用於文件、網站及儲存庫檔案。

簡介

此技能作為 Open Sharia Enterprise 儲存庫中所有 Markdown 內容的全面品質保證框架。它強制執行專業語調與一致的結構完整性,確保 docs/、網站及專案計畫中的文件保持可讀性、無障礙性與可維護性。透過強制使用主動語態與明確的標題嵌套規則,消除了模糊性,並改進開發者與相關人員的資訊檢索效率。

  • 強制執行單一 H1 使用與嚴格的標題層級嵌套,以確保文件邏輯流暢。

  • 驗證無障礙合規性,特別要求圖像需具備描述性替代文字 (alt text) 並確保符合 WCAG AA 色彩對比度。

  • 實作內容限制,如段落長度限制(≤5 行)及強制要求程式碼區塊指定語言以進行語法高亮。

  • 禁止時間性框架(例如:「這需要 5 分鐘」),以防止人為壓力並確保內容不分使用者經驗皆適用。

  • 標準化格式,包括使用粗體而非斜體進行強調,以及使用語義列表來優化螢幕閱讀器相容性。

  • 自動化儲存庫根目錄檔案(如 README.md 與 CONTRIBUTING.md)的品質檢查,提升專案呈現的專業度。

  • 提供可重複使用的檢查清單,用於手動或自動驗證,確保每份 Markdown 檔案皆符合高品質工程文件標準。

  • 在撰寫或審閱技術文件、教學內容或專案計畫時,將此技能整合至工作流程中。

  • 確保儲存庫中包含的所有圖表與圖像皆符合定義的替代文字與無障礙指南。

  • 使用此技能審核舊有內容,並在發布或重大更新前使其符合目前的儲存庫標準。

  • 保持段落簡潔且無術語堆砌,利用所提供的原則確保內容對不同技術背景的讀者皆具可及性。

倉庫統計

Star 數
9
Fork 數
1
Open Issue 數
0
主要語言
TypeScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 下午09:02
在 GitHub 查看