mcpField
P
project-docs-maintainer

project-docs-maintainer

github.com/gaelic-ghost开发65 次安装
代码仓库

关于 project-docs-maintainer

面向仓库维护者的文档维护 Skill，提供 Skills README 审查和路线图检查或限范围更新模式。流程要求先只读检查，再进行编辑，并规定报告格式与文件范围。

主要功能

  1. 01README 维护审查
  2. 02路线图验证与规范化
  3. 03编辑前先只读检查
  4. 04按模式限制更新范围
  5. 05生成 Markdown 和 JSON 报告

适用场景

  1. 01检查 Skills 仓库 README 的结构问题
  2. 02验证清单式 ROADMAP.md
  3. 03应用审查通过的文档修复
  4. 04确认文档修改后的状态

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/gaelic-ghost/productivity-skills --skill project-docs-maintainer

安装后在 Claude Code 中输入/project-docs-maintainer确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

agents/
openai.yaml
config/
roadmap-customization.template.yaml
references/
checks-common.md
checks-js-ts.md
checks-python.md
checks-rust.md
checks-swift.md
discoverability-rules.md
fix-policies.md
output-contract.md
profile-model.md
roadmap-automation-prompts.md
roadmap-config-schema.md
roadmap-customization.md
section-schema.md
seed-artifacts.md
skills-readme-maintenance-automation-prompts.md
style-rules.md
verification-checklist.md
scripts/
roadmap_alignment_maintainer.py
skills_readme_maintenance.py
tests/
test_roadmap_alignment_maintainer.py
test_skills_readme_maintenance.py

详细介绍

Project Docs Maintainer

使用一个规范的技能入口来维护文档，然后选择匹配的模式。

输入

  • mode=skills_readme_maintenance
    • 必需：--workspace <path>
    • 可选：--repo-glob <glob>、可重复使用的 --exclude <path>、--apply-fixes
  • mode=roadmap_maintenance
    • 必需：--project-root <path>、--run-mode <check-only|apply>
    • 可选：--roadmap-path <path>
  • 在所有新提示词中使用规范的模式名称。
  • 将 skills_readme_alignment 仅视为兼容用途。

工作流

  1. 根据用户请求选择规范的 mode。
  2. 首先运行只读模式：
    • skills_readme_maintenance：先审计
    • roadmap_maintenance：先使用 --run-mode check-only
  3. 检查发现的问题，并将修复范围限定在所选模式内。
  4. 如果用户要求编辑，则运行相应的受限写入路径：
    • skills_readme_maintenance：--apply-fixes
    • roadmap_maintenance：--run-mode apply
  5. 重新运行相同模式，确认是否仍有问题。
  6. 返回该模式对应的 Markdown 和 JSON 报告结构。
skills_readme_maintenance
  • 脚本：scripts/skills_readme_maintenance.py
  • 范围：维护 *-skills 仓库中的 README.md
  • 参考资料：
    • references/output-contract.md
    • references/section-schema.md
    • references/discoverability-rules.md
    • references/profile-model.md
roadmap_maintenance
  • 脚本：scripts/roadmap_alignment_maintainer.py
  • 范围：验证、迁移并受限规范清单式 ROADMAP.md
  • 参考资料：
    • references/roadmap-customization.md
    • references/roadmap-config-schema.md

输出约定

  • 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
    • 返回 Markdown 和 JSON，包含：
      • run_context
      • findings
      • apply_actions
      • errors
    • 如果没有发现问题、没有应用操作且没有错误，则准确输出 No findings.

防护措施

  • 绝不自动提交、自动推送或创建 PR。
  • 绝不编辑源代码、清单文件、锁文件或 CI 文件。
  • 在 skills_readme_maintenance 中，将编辑范围限定为 README.md，以及明确获准插入到 AGENTS.md 的代码片段。
  • 在 roadmap_maintenance 中，apply 模式只能编辑目标 ROADMAP.md。
  • 将已弃用的别名排除在主要流程之外；仅在处理旧版提示词时提及。

参考资料

  • references/output-contract.md
  • references/skills-readme-maintenance-automation-prompts.md
  • references/roadmap-automation-prompts.md
  • references/profile-model.md
  • references/section-schema.md
  • references/discoverability-rules.md
  • references/fix-policies.md
  • references/roadmap-customization.md
  • references/roadmap-config-schema.md

评论

支持 Markdown