工程開發
docs-voice avatar

docs-voice

強制執行 React 文件編寫的專業語氣、風格與技術準則,確保 Learn、Reference 與 Blog 頁面內容的一致性。

簡介

此技能作為維護 react.dev 文件庫的權威風格指南與語氣顧問。它為編寫 React 相關內容提供了標準化準則,範圍涵蓋從 Hook、Component 與 State 等核心概念,到 Server Components 與併發渲染模式等進階主題。本技能專為技術作者與貢獻者設計,旨在確保其文字與專案特定的教學目標一致,包含針對教學頁面的對話式語氣、針對 API 參考文件的技術性語氣,以及針對部落格文章的客觀事實陳述。

  • 標準化 React 概念的命名與大小寫規範(如 Hook, Effect, State),同時確保在描述性文句中正確使用小寫。

  • 定義技術元素的格式規範,包括關鍵概念的粗體標記、新術語的斜體標記,以及針對如 useState<Suspense> 等 API 的內嵌程式碼格式。

  • 實施嚴格的術語簡化策略,鼓勵在引入「批次處理 (batching)」或「引用穩定性 (referential stability)」等技術術語前,先提供白話文解釋。

  • 提供一系列經核准的類比模型,以簡化複雜的思維模式,例如元件生命週期、渲染階段,以及宣告式與指令式 UI 範式。

  • 提供特定版本文件的撰寫規範,確保 React 19 與先前版本的差異能以一致的方式呈現。

  • 規範程式碼風格,優先使用 JSX 而非 createElement,並針對回呼場景定義箭頭函式的具體使用方式。

  • 在文件更新的草稿階段使用此技能,以確保符合 react.dev 的風格標準。

  • 匯入您的草稿內容,技能將驗證其是否符合各頁面類型的語氣矩陣(Learn, Reference, Blog)。

  • 預期產出包括經過潤飾的文字、修正後的術語、格式正確的程式碼片段,以及維持 React 生態系統技術嚴謹性的結構化清單。

  • 限制條件包括避免使用如「簡單 (simple)」或「容易 (easy)」等主觀行銷用語,並嚴格禁止在文件中進行時間估算。所有內容修改均應優先考慮技術準確性與清晰度,而非說服性的行銷語言。

倉庫統計

Star 數
173
Fork 數
173
Open Issue 數
2
主要語言
JavaScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 上午05:50
在 GitHub 查看