SuperAPI AI 工具集

openclaw-refactor-docs

写作与研究

查看项目

更新于 10-16 03:06

技能介绍

用途:当用户给出某个 OpenClaw 文档页路径,要求重写、重构、重组、拆分、精简或改进时使用该技能。它建立在 technical-documentation 技能之上,后者负责风格、页面类型、结构、示例、可发现性与验证,本技能补充大规模重写时的防丢失工作流。

输入:必填为目标文档页路径(如 docs/plugins/codex-harness.md);可选包括期望页面类型(主题页、指南、参考或故障排查)、具体目标(如缩短主页、把细节移入参考页、对齐当前 CLI 行为)、相关源文件、schema、命令、测试、规格或 PR。目标页缺失或有歧义时,先问一个精简问题再动手。

工作约定:重构意在让目标页在其范围内更有用、简洁且完整,但不代表可以丢弃行为事实。须保留、核实、迁移或显式淘汰既有材料;错误的文档比冗长更糟。推荐拆分:主题或指南页覆盖 80/20 路径、决策、安全设置、最小可靠验证、常见故障与后续链接;参考页覆盖字段、默认值、枚举、限制、优先级、API 契约与罕见调试细节;故障排查页从可观察症状映射到检查、原因与修复。

流程:先读 ../technical-documentation/SKILL.md 并执行 pnpm docs:list(可用时);判断页面类型;重写前建立事实清单(配置字段、标志、命令、斜杠命令、环境变量、默认值、枚举、可空值、优先级、回退、上限、限速、超时、生命周期、队列、权限、沙箱、安全、隐私、破坏性操作、依赖、版本、错误信息等),为每条事实选择保留、迁至某页、迁至新页或因源证明过时而删除;从最近权威源核实(公共 schema、插件清单、生成的配置文档、导出类型、CLI 实现与测试、运行时源码、协议文档等),文档仅作次要证据;规划搬移目标;按推荐顺序重写;为迁移、创建或实质重写的文档页 YAML frontmatter 加 doc-schema-version: 1(仅限页面文件,不含 docs.json 与词汇表);不要留 TODO/TBD 占位;随后新旧对比并运行验证。

验证命令:pnpm docs:list;git diff --check -- <touched-files>;pnpm exec oxfmt --check --threads=1 <touched-files>;pnpm docs:check-mdx;pnpm docs:check-links;当链接文本、导航、标签或词汇表变动时运行 pnpm docs:check-i18n-glossary;涉及 schema、生成配置、API 文档或基线时运行生成文档检查。尽量运行页面中的命令与示例;无法核实的行为敏感断言应删除、标注不确定或索取源。

最终报告:目标页改了什么、细节迁往何处、哪些源码核验支撑了行为敏感断言、跑了哪些验证以及哪些失败与本次无关;不要写长篇重写日记。限制:资料未提供具体收费、价格、支持平台或效果信息。