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

update-docs — команда для Claude Code: синхронизация документации

Слэш-команда проходит по specs/, CLAUDE.md и README.md, отмечает выполненное и обновляет проценты готовности проекта.

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

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

Команда собирает текущее состояние документации: ищет markdown-файлы, считает статусные метки в docs/ и specs/, смотрит свежие коммиты по *.md за неделю. Дальше сверяет написанное с тем, что реально сделано в последней фазе, и правит расхождения.

Обновляет она четыре вещи: документ фазы, specs/implementation_status.md, спецификации реализации и корневые CLAUDE.md с README.md. Выполненные пункты помечаются ✅, проценты пересчитываются, к сложным компонентам дописываются пояснения. Новые файлы спецификаций команда не создаёт — только правит существующие в specs/. Это стоит держать в голове, если вы ждёте от неё генерации структуры с нуля.

Аргумент задаёт режим: --implementation, --api, --architecture, --sync или --validate. Инструменты ограничены Read, Write, Edit и Bash, так что правки идут прямо в файлы. В конце команда выдаёт сводку: что обновлено, какие проценты стали, какие практики записаны.

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

  • отметить выполненные задачи фазы и пересчитать проценты готовности
  • сверить спецификацию с тем, что реально закодили
  • дописать в CLAUDE.md новые практики и известные ограничения
  • обновить раздел про API после изменений в интерфейсах
  • привести testing_plan.md в соответствие со свежими прогонами тестов

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

  • /update-docs --implementation
  • /update-docs --api
  • /update-docs --sync

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

1Через claude-code-templates

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

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

.claude/commands/update-docs.md

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

Вопросы о update-docs

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

Запустите npx claude-code-templates@latest --command documentation/update-docs. Команда появится в .claude/commands/update-docs.md.

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

Синхронизирует документацию проекта с фактическим состоянием кода: расставляет статусные метки, обновляет проценты выполнения фаз и дописывает заметки о реализации.

Какие файлы она трогает?

Документы фаз и specs/implementation_status.md, спецификации реализации, CLAUDE.md и README.md. Новые файлы спецификаций не создаются.

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

update-docs.md · MIT
---
allowed-tools: Read, Write, Edit, Bash
argument-hint: "[doc-type] | --implementation | --api | --architecture | --sync | --validate"
description: Systematically update project documentation with implementation status, API changes, and synchronized content
---

# Documentation Update & Synchronization

Update project documentation systematically: $ARGUMENTS

## Current Documentation State

- Documentation structure: !`find . -name "*.md" | head -10`
- Specs directory: @specs/ (if exists)
- Implementation status: !`grep -r "✅\|❌\|⚠️" docs/ specs/ 2>/dev/null | wc -l` status indicators
- Recent changes: !`git log --oneline --since="1 week ago" -- "*.md" | head -5`
- Project progress: @CLAUDE.md or @README.md (if exists)

## Task

## Documentation Analysis

1. Review current documentation status:
   - Check `specs/implementation_status.md` for overall project status
   - Review implemented phase document (`specs/phase{N}_implementation_plan.md`)
   - Review `specs/flutter_structurizr_implementation_spec.md` and `specs/flutter_structurizr_implementation_spec_updated.md`
   - Review `specs/testing_plan.md` to ensure it is current given recent test passes, failures, and changes
   - Examine `CLAUDE.md` and `README.md` for project-wide documentation
   - Check for and document any new lessons learned or best practices in CLAUDE.md

2. Analyze implementation and testing results:
   - Review what was implemented in the last phase
   - Review testing results and coverage
   - Identify new best practices discovered during implementation
   - Note any implementation challenges and solutions
   - Cross-reference updated documentation with recent implementation and test results to ensure accuracy

## Documentation Updates

1. Update phase implementation document:
   - Mark completed tasks with ✅ status
   - Update implementation percentages
   - Add detailed notes on implementation approach
   - Document any deviations from original plan with justification
   - Add new sections if needed (lessons learned, best practices)
   - Document specific implementation details for complex components
   - Include a summary of any new troubleshooting tips or workflow improvements discovered during the phase

2. Update implementation status document:
   - Update phase completion percentages
   - Add or update implementation status for components
   - Add notes on implementation approach and decisions
   - Document best practices discovered during implementation
   - Note any challenges overcome and solutions implemented

3. Update implementation specification documents:
   - Mark completed items with ✅ or strikethrough but preserve original requirements
   - Add notes on implementation details where appropriate
   - Add references to implemented files and classes
   - Update any implementation guidance based on experience

4. Update CLAUDE.md and README.md if necessary:
   - Add new best practices
   - Update project status
   - Add new implementation guidance
   - Document known issues or limitations
   - Update usage examples to include new functionality

5. Document new testing procedures:
   - Add details on test files created
   - Include test running instructions
   - Document test coverage
   - Explain testing approach for complex components

## Documentation Formatting and Structure

1. Maintain consistent documentation style:
   - Use clear headings and sections
   - Include code examples where helpful
   - Use status indicators (✅, ⚠️, ❌) consistently
   - Maintain proper Markdown formatting

2. Ensure documentation completeness:
   - Cover all implemented features
   - Include usage examples
   - Document API changes or additions
   - Include troubleshooting guidance for common issues

## Guidelines

- DO NOT CREATE new specification files
- UPDATE existing files in the `specs/` directory
- Maintain consistent documentation style
- Include practical examples where appropriate
- Cross-reference related documentation sections
- Document best practices and lessons learned
- Provide clear status updates on project progress
- Update numerical completion percentages
- Ensure documentation reflects actual implementation

Provide a summary of documentation updates after completion, including:
1. Files updated
2. Major changes to documentation
3. Updated completion percentages
4. New best practices documented
5. Status of the overall project after this phase

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

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

Все слэш-команды по теме «Тексты и документация» →
update-docs-on-code-change официальный github Правило для GitHub Copilot, которое напоминает обновлять README.md и документацию, когда меняется код. Пригодится, если доки у вас отстают от реальности. ★ 40 418звёзд репо docs-write metabase Скилл помогает писать и редактировать Markdown и MDX в стиле Metabase. Он пригодится для рабочих инструкций, описаний функций и другой документации. CX Codex +1 2 100установок create-tldr-page официальный github Собирает страницу tldr из документации команды: короткое описание, ссылка на первоисточник и 5–8 примеров вызова. 8 800установок update-llms официальный github Скилл обновляет корневой llms.txt по структуре репозитория и спецификации llms.txt. Подойдёт, когда документация или файлы проекта меняются. 8 800установок convert-plaintext-to-md официальный github Скилл для GitHub Copilot: превращает текстовый документ в Markdown — по инструкции из запроса, по готовому образцу или по заданным параметрам. 9 000установок revise-claude-md официальный Anthropic Команда анализирует текущую сессию и предлагает лаконичные дополнения для файлов CLAUDE.md или .claude.local.md. Пригодится, когда проект оброс новыми командами сборки. ★ 44 635звёзд репо

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

Весь набор →
refactor-code Слэш-команда ведёт агента по 17 шагам рефакторинга: от анализа и тестов до проверки производительности и подготовки к ревью. 4 890установок seo-analyzer Субагент для технического SEO-аудита, разбора метатегов и Core Web Vitals. Пригодится, когда нужно проверить структуру сайта и получить список правок по приоритету. 4 060установок react-performance-optimization Субагент ищет и чинит узкие места React-приложений: лишние ре-рендеры, раздутый бандл, утечки памяти. Пригодится, когда страница тормозит или просели Core Web Vitals. 3 935установок database-optimization Субагент для разбора медленных запросов: смотрит планы выполнения, предлагает индексы и настройки пула соединений. 3 924установок supabase-schema-architect Субагент проектирует схемы PostgreSQL в Supabase, планирует миграции и пишет политики RLS. Пригодится, когда база растёт и надо навести порядок в доступе. 3 839установок smart-commit Хук Claude, который сам коммитит изменённый файл после Edit или Write. Пригодится, если не хочется вручную собирать историю git. 3 745установок architecture-review Слэш-команда для Claude, которая разбирает структуру проекта, паттерны и зависимости и выдаёт план улучшений. Пригодится перед крупным рефакторингом. 3 419установок update-search-year Хук добавляет текущий год к запросам WebSearch, если года в них нет. Пригодится, когда нужны свежие результаты, а не прошлогодние. 3 412установок

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

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