project-docs-maintainer

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Project Docs Maintainer

项目文档维护工具

Use one canonical skill entrypoint for documentation maintenance, then choose the matching mode.

通过统一的标准化技能入口点进行文档维护，然后选择匹配的模式。

Inputs

输入参数

mode=skills_readme_maintenance

Required:
```
--workspace <path>
```

Optional:

--repo-glob <glob>

, repeatable

--exclude <path>

--apply-fixes

mode=roadmap_maintenance

Required:

--project-root <path>

--run-mode <check-only|apply>

Optional:
```
--roadmap-path <path>
```

Use canonical mode names in all new prompts.
Treat
```
skills_readme_alignment
```
as compatibility-only.

mode=skills_readme_maintenance

必填：
```
--workspace <路径>
```

可选：

--repo-glob <通配符路径>

，可重复使用

--exclude <路径>

，

--apply-fixes

mode=roadmap_maintenance

必填：

--project-root <路径>

，

--run-mode <check-only|apply>

可选：
```
--roadmap-path <路径>
```

所有新请求中请使用标准化的模式名称。
```
skills_readme_alignment
```
仅用于兼容旧版本。

Workflow

工作流

Pick the canonical
```
mode
```
from the user request.

Run the read-only variant first:

```
skills_readme_maintenance
```
: audit first

roadmap_maintenance

--run-mode check-only

first

Review findings and keep the fix scope bounded to the selected mode.

If the user requested edits, run the corresponding bounded write path:

```
skills_readme_maintenance
```
:
```
--apply-fixes
```
```
roadmap_maintenance
```
:
```
--run-mode apply
```

Re-run the same mode to confirm remaining issues.
Return the mode-specific Markdown and JSON report shape.

从用户请求中选择标准化的
```
mode
```
。

先运行只读变体：

```
skills_readme_maintenance
```
：先执行审计

roadmap_maintenance

：先使用

--run-mode check-only

模式

检查结果，确保修复范围限定在所选模式内。
如果用户要求进行编辑，则运行对应的有限范围写入流程：
- ```
skills_readme_maintenance
```
  ：使用
```
--apply-fixes
```
- ```
roadmap_maintenance
```
  ：使用
```
--run-mode apply
```
重新运行同一模式以确认剩余问题。
返回对应模式的Markdown和JSON格式报告。

skills_readme_maintenance

skills_readme_maintenance

Script:
```
scripts/skills_readme_maintenance.py
```
Scope:
```
README.md
```
maintenance for
```
*-skills
```
repositories

References:

```
references/output-contract.md
```
```
references/section-schema.md
```
```
references/discoverability-rules.md
```
```
references/profile-model.md
```

脚本：
```
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

roadmap_maintenance

Script:
```
scripts/roadmap_alignment_maintainer.py
```
Scope: checklist-style
```
ROADMAP.md
```
validation, migration, and bounded normalization

References:

```
references/roadmap-customization.md
```
```
references/roadmap-config-schema.md
```

脚本：
```
scripts/roadmap_alignment_maintainer.py
```
范围：对清单式
```
ROADMAP.md
```
进行验证、迁移和有限范围的标准化处理

参考文档：

```
references/roadmap-customization.md
```
```
references/roadmap-config-schema.md
```

Output Contract

输出约定

skills_readme_maintenance

Return Markdown plus JSON with:

```
run_context
```
```
repos_scanned
```
```
profile_assignments
```
```
schema_violations
```
```
command_integrity_issues
```
```
fixes_applied
```
```
post_fix_status
```
```
errors
```

If there are no issues and no errors, output exactly
```
No findings.
```

```
roadmap_maintenance
```
- Return Markdown plus JSON with:
  - ```
  run_context
```
- ```
findings
```
  - ```
  apply_actions
```
- ```
errors
```
- If there are no findings, no apply actions, and no errors, output exactly
```
No findings.
```

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.
```

Guardrails

约束规则

Never auto-commit, auto-push, or open a PR.
Never edit source code, manifests, lockfiles, or CI files.
In
```
skills_readme_maintenance
```
, keep edits bounded to
```
README.md
```
and explicitly approved snippet insertions into
```
AGENTS.md
```
.
In
```
roadmap_maintenance
```
,
```
apply
```
mode may edit only the target
```
ROADMAP.md
```
.
Keep deprecated aliases out of the main path and mention them only when handling legacy prompts.

禁止自动提交、自动推送或创建PR。
禁止编辑源代码、清单文件、锁文件或CI配置文件。
在
```
skills_readme_maintenance
```
模式下，仅允许编辑
```
README.md
```
，以及在明确批准的情况下向
```
AGENTS.md
```
插入代码片段。
在
```
roadmap_maintenance
```
模式下，
```
apply
```
模式仅允许编辑目标
```
ROADMAP.md
```
文件。
主工作流中不使用已弃用的别名，仅在处理旧版本请求时提及它们。

References

参考文档

```
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
```

```
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
```