工程开发
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 查看