用途:为开发者和编码代理撰写、编辑、审阅技术文档,覆盖 Docu MDX、README 及根级产品 Markdown。写作前须先读仓库的 AGENTS.md,了解文档分层、公开一句话描述、能力名称、禁用文案及 DESIGN.md 位置;.cursor/rules/ 中的 glob 规则优先于本技能。层级路由交由 /w-docs 处理,本技能不重复其路由表。
文风:以“你”称呼读者,步骤用祈使动词,主动语态、现在时、具体名词;美式英语与牛津逗号;命名运行时时写 eve 小写。每页只承担一个主要任务,先在页面和段落开头给出答案或结果。保原作者支持的含义、细微差别与不确定性,做最小有效修改。仅在描述仓库中记录的团队主动行动时使用 we。
禁用与限制:禁止使用 easy、simple、quick、just、obviously、utilize、facilitate、leverage、robust、seamless 等填充与宣传词,以及反问和诱导互动;禁止 AI 味表达,如总结式过渡、数据表式动词(provides、is configurable)、模板结尾和生造细节。不得依赖训练数据判断行为,须依次核实:仓库中的权威源码、公开类型与测试;最近 README 中提到的 CLI 帮助与包脚本;AGENTS.md 指定的 MDX 或 Markdown;ADR 与架构页(仅在合并行为一致时视为已交付);Issue 与用户反馈(用于理解读者问题,不作为产品事实)。无法核实的论断应删除或点明缺失的责任人,定稿中不得保留 [VERIFY],不得把拟定行为写成已发布。
方法:先命名文档的唯一职责与读者任务;优先扩展现有主题页面而非新建;大纲为结果→前置条件→顺利路径→替代方案→失败→相关链接;边写边对照源码核实;自审时重复完整名词、把关键事实放在本地而非仅藏在链接后;按目的结构、准确性、完整性、文风检索、diff 纪律分步审阅。
三种模式:Docu MDX 需 title 与 description frontmatter,导航变化时改 meta.json,从相关枢纽页加入正文内链(不留孤儿页),路由迁移时在 doc 应用配置中设永久重定向,MDX 组件仅沿用邻近页面用法,交付前运行 pnpm --filter @repo/docu checktypes;README 遵循 .cursor/rules/base/readme.mdc,根 README 讲产品故事,应用与包保持精简并链接技术文档;根级产品 Markdown(如 PRODUCT.md、ARCHITECTURE.md、DESIGN.md)沿用同一文风,能力名称与该仓库架构源一致。
约束:绝不编造标志、端点、默认值、示例、指标或用户反馈;不把单条支持讨论直接变成新页面;不用新页面重复已有指南,优先补章节或交叉链接;不为了叙事便利违背仓库的公开一句话描述、禁用文案或能力名称。本技能不涉及 /w-docs、/w-api-docs、/w-deslop、/w-architecture 及个人或营销口吻目录。