plain-language
一套用於編寫清晰、易讀且簡潔內容的工具。應用「淺顯語言運動」原則,包括主動語態、縮短句子和消除行話,以提升讀者理解度。
簡介
plain-language 技能為起草和潤飾文本提供了系統性架構,以確保讀者能立即理解內容。此技能專為撰稿人、開發人員和技術交流人員設計,特別適用於優先考慮清晰度而非複雜性的內容創建階段。藉由運用 2010 年《淺顯寫作法案》(Plain Writing Act of 2010)及更廣泛的「淺顯語言運動」技巧,它有助於降低認知負荷、提升閱讀速度並增進內容的易讀性,即使是偏好直接溝通、厭惡模糊行話的技術人員也能受惠。
-
將主動語態的使用率提高至 80% 以上,確保溝通具備行動導向的直接性。
-
強制執行句子長度限制,將平均字數維持在 25 字以內以優化閱讀體驗。
-
提供消除行話的自動化指導,偏好簡單、標準的術語而非晦澀難懂的流行語。
-
包含降低名詞化(nominalization)以及刪除模糊詞或冗詞的具體技巧。
-
將應用模式細分為教學(Tutorial)、操作指南(How-To)、參考資料(Reference)與說明(Explanation),以符合情境需求。
-
內建 Flesch-Kincaid 可讀性與主動語態比例的衡量指標。
-
最適用於潤飾文件、API 指南、技術教程或專案 README 檔案。
-
使用者應監控輸出內容中是否包含如 'was/were + past participle + by' 等被動語態標記。
-
預期輸入為需要簡化的草稿,輸出則為更簡潔、更有力且更易於閱讀的修訂版本。
-
限制:技術準確性需與清晰度取得平衡;僅在首次出現時定義明確的前提下,才允許使用專業行話。
-
建議用於管理高認知負荷可能成為採用障礙或影響開發者入門效率的內容。
-
在最終發布前,請務必使用提供的品質檢查清單來審核是否符合可讀性指標。
倉庫統計
- Star 數
- 63
- Fork 數
- 17
- Open Issue 數
- 0
- 主要語言
- Python
- 預設分支
- main
- 同步狀態
- 閒置
- 最近同步時間
- 2026年5月3日 上午09:28