用途:为仓库的 packages/docs 应用创建和维护面向外部用户的公开产品文档,适用于撰写、修订或审阅文档页面。
主要能力:按请求类型选择路径,包括新页面撰写、既有页面重构与澄清、信息架构更新(侧边栏、重定向、导航)、文档质量检查(准确性、可扫读性、一致性)以及文档应用的故障排查与构建修复。
使用方式:按需加载参考文件——了解文档应用布局与约束读 references/api-surface.md;起草或修订常见页面读 references/common-use-cases.md;诊断文档质量或构建失败读 references/troubleshooting-workarounds.md。流程为:先分类请求,再收集本地上下文(阅读 packages/docs/src/content/docs/contribute/documentation-guidelines.md、同章节相邻文档;涉及导航时读 packages/docs/astro.config.mjs;涉及公开接口时核对导出的 TypeScript 表面及其注释),然后按文档类型(概念、教程、参考、故障排查)撰写或编辑,最后验证。
核心约束:内容面向读者,解释用户结果而非内部实现;遵循本地文档规范;新建或大幅修改的页面需包含 frontmatter 字段 type、summary、prerequisites、related;教程与故障排查内容需给出具体验证步骤;每页以内部链接指向明确的下一步;优先使用最小可运行示例;列表周围保留正文,避免只有标题加项目符号的段落。
验证命令:运行 pnpm docs:check;当结构、侧边栏或重定向变化时,另运行 pnpm docs:build。
完成报告:返回变更文件及每项改动对读者的改进、已执行的验证命令与结果、残余风险(如缺少截图、未验证的环境特定设置)。
限制:资料未提供具体收费、价格、平台支持范围或效果数据;未提供官方文本。