SuperAPI AI 工具集

project-docs-maintainer

写作与研究

查看项目

更新于 10-15 21:49

技能介绍

用途:通过一个规范化入口维护项目文档,先选择对应模式再执行。主要用于两类任务:*-skills 仓库的 README 标准维护,以及清单式 ROADMAP 文档的验证、迁移与有限规范化。

主要能力与模式:skills_readme_maintenance 模式,脚本为 scripts/skills_readme_maintenance.py,作用是审查 *-skills 仓库的 README.md,需要 --workspace <path>,可选 --repo-glob <glob>、可重复的 --exclude <path>、--apply-fixes。roadmap_maintenance 模式,脚本为 scripts/roadmap_alignment_maintainer.py,用于清单式 ROADMAP.md 的验证、迁移和有限规范化,需要 --project-root <path>、--run-mode <check-only|apply>,可选 --roadmap-path <path>。skills_readme_alignment 仅作为兼容别名,不应出现在新提示中。

使用方式:先按用户请求选择规范模式;优先运行只读变体,skills_readme_maintenance 先审计,roadmap_maintenance 先用 --run-mode check-only;审阅发现后把修复范围限制在所选模式内;若用户要求编辑,再运行对应写入路径,skills_readme_maintenance 用 --apply-fixes,roadmap_maintenance 用 --run-mode apply;随后重跑同一模式确认剩余问题,并返回对应模式的 Markdown 与 JSON 报告。

输出契约:skills_readme_maintenance 返回 Markdown 加 JSON,字段包括 run_context、repos_scanned、profile_assignments、schema_violations、command_integrity_issues、fixes_applied、post_fix_status、errors;若无线索也无错误,输出 No findings。roadmap_maintenance 返回 run_context、findings、apply_actions、errors;若无 findings、无 apply actions、无 errors,输出 No findings。

限制:绝不自动提交、自动推送或打开 PR;绝不编辑源代码、清单、锁文件或 CI 文件。skills_readme_maintenance 仅限编辑 README.md,以及明确批准的向 AGENTS.md 插入片段;roadmap_maintenance 的 apply 模式只能编辑目标 ROADMAP.md。模式命名与配置文件细节、具体检查规则和输出字段的完整语义以所附 references 文档为准。