Maintain Documentation Tone
使用此技能,確保此儲存庫中的所有文件都能保持一致、友善且充滿熱情的語調。
使用此技能的時機
- 使用者要求撰寫、編輯或更新文件中的
.md檔案。 - 您正在為 Astro 網站新增頁面。
- 使用者要求您審查文件的語調或風格。
不應使用此技能的時機
- 編輯嚴謹的技術合約(例如 OpenAPI 規格或內部 JSON Schema),因為口語化的語調可能導致解析錯誤或混淆。
- 使用者明確要求某個檔案(例如官方的法律免責聲明)採用正式、乾澀或學術性的語調。
第一步
- 閱讀位於
references/tone-guidelines.md中的確切語調要求與範例。 - 掃描您即將編輯的文件,確保您的變更能與周圍文字無縫融合。
工作流程
- 將語調指南(熱情、易於理解、適合使用表情符號)套用至您的草稿。
- 將機械化或過於企業化的措辭(例如「此應用程式執行初始化序列」)替換為友善、人性化的措辭(例如「開始使用輕而易舉!只需執行這個指令:」)。
- 確保格式化使用現代 Markdown 功能(使用粗體強調、使用項目符號提高可讀性)。
驗證
- 檢查表情符號: 該段落是否至少有一個得體且相關的表情符號?
- 檢查語調: 在腦中朗讀文字。聽起來像是一位友善的開發者與您結對編程,還是像一本企業手冊?如果是後者,請重寫。
範例
- 「更新快速入門指南以包含新的設定旗標。」 -> 觸發此技能,確保新步驟以熱情的方式撰寫。
- 「撰寫一份關於轉移至 Astro 的 ADR。」 -> 觸發此技能,確保 ADR 清晰明瞭但依然平易近人。