Skip to main content
command

docs-maintenance — Claude Code command: what it does, how to install

This command audits documentation, links, structure, and style, then helps plan updates. Use it when Markdown docs need recurring checks.

Install into Claude Code · claude-code-templates All methods and platforms ↓
npx claude-code-templates@latest --command documentation/docs-maintenance
Open on GitHub

What docs-maintenance does

docs-maintenance builds a documentation maintenance workflow around an audit. It finds *.md and *.mdx files, checks freshness, word count, readability, heading structure, missing sections, and TODO/FIXME markers. You can run it with --audit, --update, --validate, --optimize, or --comprehensive.

The checks cover external and internal links, image references, Markdown syntax, code blocks, alt text, metadata, spelling, and readability. The command also lays out Git-based synchronization, prioritized reports, monitoring, recurring maintenance, and rollback procedures. It uses Read, Write, Edit, Bash, and Grep; its file discovery targets Markdown and MDX, so other documentation formats are outside that scan.

What it helps with

  • audit a Markdown documentation set
  • find broken links and missing image assets
  • check heading hierarchy and Markdown style
  • track incomplete sections and TODO markers
  • prepare recurring documentation maintenance procedures

Example prompts for the agent

  • Run a documentation audit with /docs-maintenance --audit.
  • Validate links, images, and Markdown formatting with /docs-maintenance --validate.
  • Design a complete maintenance workflow and prioritized report with /docs-maintenance --comprehensive.

How to install docs-maintenance

1claude-code-templates

npx claude-code-templates@latest --command documentation/docs-maintenance

2Manually: put the files in place

.claude/commands/docs-maintenance.md

Call it with /docs-maintenance. For all projects use ~/.claude/commands/

Questions about docs-maintenance

How do I install docs-maintenance in Claude Code?

Run npx claude-code-templates@latest --command documentation/docs-maintenance, then add .claude/commands/docs-maintenance.md.

What does docs-maintenance do?

It audits Markdown documentation for broken references, structure, style, accessibility, freshness, and incomplete content. It also helps define update workflows, reports, monitoring, and Git synchronization.

Which modes does docs-maintenance support?

You can pass --audit, --update, --validate, --optimize, or --comprehensive, or provide a custom maintenance type.

Source text

docs-maintenance.md · MIT
---
allowed-tools: Read, Write, Edit, Bash, Grep
argument-hint: "[maintenance-type] | --audit | --update | --validate | --optimize | --comprehensive"
description: Use PROACTIVELY to implement comprehensive documentation maintenance systems with quality assurance, validation, and automated updates
---

# Documentation Maintenance & Quality Assurance

Implement comprehensive documentation maintenance system: $ARGUMENTS

## Current Documentation Health

- Documentation files: !`find . -name "*.md" -o -name "*.mdx" | wc -l` files
- Last updates: !`find . -name "*.md" -exec stat -f "%m %N" {} \; | sort -n | tail -5`
- External links: !`grep -r "http" --include="*.md" . | wc -l` links to validate
- Image references: !`grep -r "!\[.*\]" --include="*.md" . | wc -l` images to check
- Documentation structure: @docs/ or detect documentation directories

## Task

Create systematic documentation maintenance framework with automated quality assurance, comprehensive validation, content optimization, and regular update procedures.

## Documentation Maintenance Framework

### 1. Content Quality Audit System
- Comprehensive file discovery and categorization
- Content freshness analysis and aging detection
- Word count, readability, and structure assessment
- Missing sections and incomplete documentation identification
- TODO/FIXME marker tracking and resolution planning

### 2. Link and Reference Validation
- External link health monitoring with retry logic
- Internal link validation and broken reference detection
- Image reference verification and missing asset identification
- Cross-reference consistency checking
- Automated link correction suggestions

### 3. Style and Consistency Checking
- Markdown syntax validation and formatting standards
- Heading hierarchy and structure consistency
- List formatting and emphasis style uniformity
- Code block formatting and language specification
- Accessibility compliance (alt text, descriptive links)

### 4. Content Optimization and Enhancement
- Table of contents generation for long documents
- Metadata updating and frontmatter management
- Common formatting issue correction
- Spelling and grammar validation
- Readability analysis and improvement suggestions

### 5. Automated Synchronization System
- Git-based change tracking and documentation updates
- Version control integration with branch management
- Automated commit generation with detailed change logs
- Merge conflict resolution strategies
- Rollback procedures for failed updates

### 6. Quality Assurance Reporting
- Comprehensive audit reports with severity classifications
- Issue categorization and prioritization systems
- Progress tracking and maintenance metrics
- Automated notification systems for critical issues
- Dashboard creation for ongoing monitoring

## Implementation Requirements

### Audit Configuration
- Configurable quality thresholds and validation rules
- Custom style guide integration and enforcement
- Platform-specific optimization settings
- Team collaboration workflow integration
- Automated scheduling and recurring maintenance

### Validation Processes
- Multi-level validation with error categorization
- Batch processing for large documentation sets
- Performance optimization for comprehensive scans
- Integration with existing CI/CD pipelines
- Real-time monitoring and alerting systems

### Reporting and Analytics
- Detailed maintenance reports with actionable insights
- Historical trend analysis and improvement tracking
- Team productivity metrics and documentation health scores
- Integration with project management tools
- Automated stakeholder communication

## Deliverables

1. **Maintenance System Architecture**
   - Automated audit and validation framework
   - Content optimization and enhancement tools
   - Quality assurance reporting infrastructure
   - Version control integration and synchronization

2. **Validation and Quality Tools**
   - Link checking and reference validation systems
   - Style consistency and accessibility compliance tools
   - Content freshness and completeness analyzers
   - Automated correction and enhancement utilities

3. **Reporting and Monitoring**
   - Comprehensive audit reports with prioritized recommendations
   - Real-time monitoring dashboards and alert systems
   - Progress tracking and maintenance history documentation
   - Integration with team communication and project tools

4. **Documentation and Procedures**
   - Implementation guidelines and configuration instructions
   - Team workflow integration and collaboration procedures
   - Troubleshooting guides and maintenance best practices
   - Automated scheduling and recurring maintenance setup

## Integration Guidelines

Implement with existing documentation platforms and development workflows. Ensure scalability for large documentation sets and team collaboration while maintaining quality standards and accessibility compliance.

© davila7 · MIT · davila7/claude-code-templates

Similar slash commands

All slash commands for Writing and docs →

From the same set205

The whole set →

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor