skills.rest
grafana
grafanaOFFICIAL
Explore all skills by this author →
Website𝕏@grafanaGitHub

maintain-docs

Detect documentation drift and update the maintenance backlog.

19|31|Updated May 29, 2025
Search Tags:#automation#documentation#markdown#drift-detection#quality-assurance#backlog-management#orphaned-docs
Ready to run
npx skills add https://github.com/grafana/grafana-pathfinder-app --skill maintain-docs-grafana
💬 Prompt for ChatGPT / Claude Chat▼
Please help me install this Agent Skill.
Skill: maintain-docs
Source: https://github.com/grafana/grafana-pathfinder-app/tree/main/.cursor/skills/maintain-docs
Command: npx skills add https://github.com/grafana/grafana-pathfinder-app --skill maintain-docs-grafana

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Periodic documentation maintenance audits to detect drift between code and docs, identify orphaned entries, and keep a persistent backlog synchronized with PR workflows.

Core Features & Use Cases

  • Detect drift between .cursor/rules/ and docs/developer/ and reconcile with code
  • Identify orphaned docs and missing references in AGENTS.md
  • Manage a persistent backlog of validated docs, exclusions, and new work items across runs
  • Support PR-driven fixes and iterative improvements

Quick Start

Run maintain-docs to audit the knowledge base, identify drift and orphaned docs, and update the backlog.

Frequently Asked Questions about maintain-docs

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

FAQPage Schema
How do I detect documentation drift between source code and markdown files?▼

You can automate drift-detection by running an audit that compares code documentation against source code to identify structural inconsistencies and missing references. The maintain-docs Skill performs this drift-detection process and updates a persistent backlog with the results.

What is the best way to find orphaned docs and missing references in AGENTS.md?▼

Finding orphaned docs and missing references in AGENTS.md is best handled by an on-demand audit that scans the documentation structure for outdated entries. The maintain-docs Skill identifies these orphaned entries and tracks them in a maintenance backlog.

Can I use maintain-docs to automatically rewrite source code during a documentation audit?▼

No, you cannot use maintain-docs to rewrite source code. It enforces a strict constraint to edit only markdown files, ensuring source code remains untouched while it reconciles documentation drift and updates the maintenance backlog.

How do I manage a persistent backlog of documentation maintenance tasks across multiple runs?▼

Managing a persistent backlog across multiple runs is achieved by tracking audit outcomes, including validated docs, exclusions, and new work items, in a synchronized file. The maintain-docs Skill automatically updates this maintenance backlog after each drift-detection run.

When should I run a documentation maintenance audit for post-feature reviews?▼

A documentation maintenance audit for post-feature reviews should be run after new code is merged to catch drift early. The maintain-docs Skill supports periodic maintenance and PR-driven fixes to keep AGENTS.md and developer docs synchronized with the source code.

Related Skills

Explore More Content & Communication Skills→
cslsoftwarescslsoftwares

documentation-class-analysis-generator

Generate structured Markdown documentation for classes and interfaces from source code.

Community
Advanced
aayushsoamaayushsoam
1

gh-issues

Automate GitHub issue triage and pull request creation via sub-agents.

Community
Advanced
DevelopersGlobalDevelopersGlobal
65

ci-cd-pipelines

Automate CI/CD pipelines with quality gates and deployment processes.

Official
Advanced
useblocksuseblocks
24

pharaoh-mece

Analyzes sphinx-needs traceability graphs to identify gaps, orphaned nodes, redundancies, and status or ID inconsistencies across req, spec, impl, and test types.

Official
Advanced