docs-maintenance

Update documentation and cross-references for agent-workflows projects.

73|7|Updated May 26, 2026
One-click install
npx skills add https://github.com/franklioxygen/agent-workflows --skill docs-maintenance-franklioxygen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-maintenance
Source: https://github.com/franklioxygen/agent-workflows/tree/main/zh-cn/skills/docs-maintenance
Command: npx skills add https://github.com/franklioxygen/agent-workflows --skill docs-maintenance-franklioxygen

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

通过系统化维护,减少 agent-workflows 文档中常见的遗漏、过期引用和跨文件不一致,避免用户在选择工作流与安装技能时被误导。

Core Features & Use Cases

  • 文档与清单一致性维护:更新 README 条目、工作流路由、库加载参考、技能文档与交叉引用,确保文档资产与实际文件同名同结构。
  • 交叉引用修复与一致性治理:修复 Markdown 链接、标题锚点、共享约定与重复措辞,保障跨文件口径一致。
  • 验证与审计驱动的变更交付:通过文档盘点与共享规则约束,验证链接、清单、脚本与关键约定是否匹配,并输出变更报告。

Quick Start

运行 scripts/docs_inventory.py /path/to/agent-workflows 来盘点 Markdown 文档和常见文档信号。

Frequently Asked Questions about docs-maintenance

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I maintain documentation consistency and fix broken cross-references in a repository?

Documentation maintenance ensures cross-references and shared conventions match actual files. You update README enumerations, workflow routing, and skill documentation to fix broken Markdown links and anchor mismatches, keeping repository discovery accurate.

What is the best way to audit Markdown links and workflow listings in agent-workflows?

Auditing Markdown links and workflow listings requires running a docs inventory script to scan the repository. This generates a report of mismatched cross-references and outdated workflow routing, which you repair while preserving workflow semantics.

How do I update workflow routing and README entries without breaking file semantics?

To update workflow routing and README entries without breaking semantics, follow a documented maintenance checklist to apply only documentation-scoped changes. This updates installable skill documentation and library load references while leaving underlying workflow logic untouched.

Can I use this approach to fix heading anchors and duplicate phrasing across multiple Markdown files?

Yes, this approach fixes heading anchors and duplicate phrasing across Markdown files. It enforces cross-file consistency by repairing shared references and standardizing terminology, ensuring that routing and discovery assets remain structurally aligned.

Why do outdated workflow listings and stale library references mislead users during skill selection?

Outdated workflow listings and stale library references mislead users because they create a gap between documented assets and actual repository structure. Systematic documentation maintenance closes this gap by aligning cross-references and shared conventions with real files.

When should I run a repository documentation audit to check for missing or expired references?

You should run a repository documentation audit whenever you add, rename, or remove workflow files to prevent expired references. Running the docs inventory script validates that Markdown links and skill documentation match the current file structure.