用途:在编写 React 文档时统一语气、术语和风格。
主要能力:规定 React 概念的术语大小写(Hook、Effect、State、Context、Ref、Component、Fragment、Transition、Action、Suspense、Server Component、Error Boundary 等);描述词搭配时用小写(如 state variable、event handler),概念独立出现或作标题时大写;产品名 ESLint、TypeScript、JavaScript、Next.js 保持正确写法;关键概念用粗体、新术语定义用斜体、API 用行内代码。禁止使用 simple、easy、just 及时间估计,避免被动语态与行话;差异表述为“能力”而非优劣。
页面语气:Learn 偏对话式,Reference 偏技术性,Blog 重事实而非营销;Pitfall 与 DeepDive 组件在 Reference 页中也可稍偏口语。
行话处理:先解释行为再命名;用通俗说法替代 atomic、idempotent、deterministic、memoize、invariant 等;stale closures、stable identity、reactive 可在 Reference 页直接使用。类比只在引入概念时用一次,如组件与 React 比作厨房、纯函数比作食谱、Props 比作旋钮。
写法模式:以“错误示例/正确示例”对比代码,用表格比较差异,用链接指向相关学习页与参考页;代码偏好 JSX 而非 createElement,使用 const/let 不用 var,顶层函数用命名函数声明,回调可用箭头函数。
版本说明:新 API 用“Starting in React 19...”,旧写法用“In older versions of React...”。
适用场景:编写 React 官方文档各类页面。限制:资料未提供具体工具安装方式、收费、平台与效果信息,均暂未提供。