К основному содержанию
команда

docs-maintenance — команда Claude Code: что делает и установка

Команда проверяет документацию, ссылки, структуру и стиль, а затем помогает подготовить обновления. Пригодится для регулярного аудита Markdown-файлов.

Установить в Claude Code · Через claude-code-templates Все способы и платформы ↓
npx claude-code-templates@latest --command documentation/docs-maintenance
Открыть на GitHub

Что делает docs-maintenance

docs-maintenance запускает аудит документации и предлагает систему её обслуживания. Команда ищет файлы *.md и *.mdx, проверяет свежесть, структуру, объём, незаполненные разделы и маркеры TODO/FIXME. Доступны режимы --audit, --update, --validate, --optimize и --comprehensive.

В проверку входят внешние и внутренние ссылки, изображения, Markdown-разметка, иерархия заголовков, блоки кода, alt-текст, метаданные, орфография и читаемость. Команда также описывает синхронизацию через Git, отчёты с приоритетами, мониторинг и процедуры отката. Она использует Read, Write, Edit, Bash и Grep; автоматические подсчёты ориентированы на Markdown и MDX, поэтому документация в других форматах не попадёт в этот поиск.

Какие задачи решает

  • провести аудит Markdown-документации
  • найти битые ссылки и отсутствующие изображения
  • проверить структуру заголовков и форматирование
  • собрать отчёт по незаполненным разделам
  • подготовить правила регулярного обновления docs

Примеры запросов агенту

  • Запусти аудит документации проекта с помощью /docs-maintenance --audit.
  • Проверь ссылки, изображения и Markdown-разметку через /docs-maintenance --validate.
  • Подготовь систему обслуживания документации и отчёт с приоритетами через /docs-maintenance --comprehensive.

Как установить docs-maintenance

1Через claude-code-templates

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

2Вручную: положить файлы

.claude/commands/docs-maintenance.md

Вызов — /docs-maintenance. Для всех проектов — ~/.claude/commands/

Вопросы о docs-maintenance

Как установить docs-maintenance в Claude Code?

Выполните npx claude-code-templates@latest --command documentation/docs-maintenance, затем добавьте файл .claude/commands/docs-maintenance.md.

Что делает docs-maintenance?

Команда проверяет Markdown-документацию, ссылки, изображения, структуру, стиль, доступность и признаки устаревания. Она также помогает оформить отчёты, процедуры обновления и Git-синхронизацию.

Какие режимы есть у docs-maintenance?

Для запуска можно передать --audit, --update, --validate, --optimize или --comprehensive, а также указать собственный тип обслуживания.

Исходный текст

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

Похожие слэш-команды

Все слэш-команды по теме «Тексты и документация» →

Из того же набора205

Весь набор →
supabase-schema-sync Команда сверяет локальную схему базы данных с удалённым проектом Supabase через MCP-сервер. Помогает быстро находить расхождения и готовить файлы миграций. 1 405установок init-project Разворачивает структуру нового проекта: каталоги, git, линтеры, тесты и CI. Пригодится, когда нужно начать с чистого листа без ручной возни. 1 382установок backup-before-edit Хук Claude делает копию файла с меткой времени перед каждой правкой. Пригодится, когда агент переписывает код и хочется откатиться. 1 328установок containerize-application Слэш-команда собирает Docker-конфигурацию под ваш проект: Dockerfile, .dockerignore, docker-compose и заготовки для Kubernetes. 1 200установок supabase-data-explorer Команда исследует данные и схему Supabase, выполняет SQL-запросы только для чтения и готовит экспорт или визуализацию. Пригодится для проверки базы прямо из проекта. 1 032установок test-runner Хук запускает тесты сразу после того, как Claude изменил файл. Полезен, если не хочется вручную гонять проверки после каждой правки. 1 027установок supabase-performance-optimizer Слэш-команда для Claude, которая находит медленные запросы и лишние индексы в базе Supabase и предлагает план оптимизации. 1 026установок design-database-schema Команда проектирует структуру базы данных с учётом связей, ограничений и запросов. Она пригодится при создании схемы или пересмотре существующей. 1 021установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой