document-writer
Nuxt 生態系統專用的技術文件寫作助手,提供寫作風格指南、MDC 組件使用模式與技術部落格結構規範。
簡介
document-writer 技能是一個專為 Nuxt.js 生態系統中的開發者與維護者設計的技術寫作助手。它執行嚴格的清晰度與語法標準,確保技術內容既專業又與官方 Nuxt 文件模式一致。與優先考慮簡潔性的通用寫作工具不同,此技能要求使用完整句子與正式語法,非常適合用於高品質文件、API 指南與版本公告部落格文章。
此技能與 Nuxt Content 及 Nuxt UI 生態系統深度整合。它引導用戶正確實作 MDC (Markdown Components) 語法,確保技術說明能搭配正確的標註類型 (note, tip, warning, important) 與 UI 組件。它還支援部落格文章的特定前置資料 (frontmatter) 結構,確保元數據與作者資訊能正確處理以利 SEO 與呈現。
-
提供專業的寫作風格指南,著重於主動語態、現在時態與明確的句子結構。
-
為 Nuxt 部落格文章提供結構模式,包括前置資料模板與邏輯內容流。
-
管理 MDC 組件使用方式,包括程式碼高亮與 prose 組件整合。
-
根據特定的品質檢查清單驗證技術文件,包括 H1 格式規則與程式碼區塊中的檔案路徑標記。
-
與 nuxt-content 及 nuxt-ui 技能協調,提供組件特定的文件與使用元數據。
-
定義特定的情態動詞 (can, should, must) 以區分可選、推薦與必要的操作。
-
在撰寫技術文件或 Nuxt 模組公告時使用此技能。
-
當需要調整語氣、語調或句子結構時,載入 writing-style.md 參考檔案。
-
在建立新部落格文章或複雜的 MDC 文件結構時,載入 content-patterns.md 參考檔案。
-
確保所有 H1 標題不包含反引號,以保證在 Nuxt Content 系統中能正確渲染。
-
優先遵循「先解釋再放程式碼」的原則,以維護讀者的上下文與清晰度。
-
用戶應確保標註類型與其實際意圖一致 (例如:使用 warning 表示重大變更,使用 important 表示必要設定步驟)。
倉庫統計
- Star 數
- 648
- Fork 數
- 29
- Open Issue 數
- 3
- 主要語言
- TypeScript
- 預設分支
- main
- 同步狀態
- 閒置
- 最近同步時間
- 2026年4月30日 上午08:11