К основному содержанию
правило CX Codex

docs-markdown — правило для Claude Code: что делает и как установить

Правило docs-markdown задаёт требования к markdown-документам проекта: рабочие примеры команд, пути от корня и синхронное обновление всех README, когда меняются процессы.

MIT ★ 1 198 обновлён 2026-10-23

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/rules/docs-markdown.md
Открыть на GitHub

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

Правило перечисляет, каким должен быть markdown в репозитории: примеры команд запускаются и совпадают с настоящими скриптами, пути к файлам проекта идут от корня, а утверждения об архитектуре описывают то, что код делает сейчас.

Отдельный пункт — синхронность. Если поменялся рабочий процесс, правятся сразу README.md, README-EN.md с зеркалами, ARCHITECTURE, SETUP, INSTALL и mcp/README. Разделы при этом короткие, а в траблшутинге нужны конкретные шаги, а не общие слова.

В шапке файла стоит paths: **/*.md, поэтому правило срабатывает только на markdown и не трогает исходники. Самый частый провал здесь — обновить один README из списка и забыть остальные: тогда доки начинают противоречить друг другу.

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

  • держать примеры команд в документации рабочими
  • проставить пути от корня проекта вместо случайных относительных
  • обновить все связанные README за один проход после смены процессов
  • убрать из описания архитектуры то, чего в коде уже нет
  • сократить раздел и заменить общие слова конкретными шагами траблшутинга

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

  • Обнови README.md и ARCHITECTURE под новый порядок запуска, команды проверь на работоспособность.
  • Перепиши раздел про установку в README-EN.md: пути от корня проекта, в траблшутинге конкретные шаги.
  • Мы переделали структуру mcp/README — пройдись по всем докам, где это упоминается.

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

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

.claude/rules/docs-markdown.md

Поле paths во frontmatter ограничивает файлы

По шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать

Вопросы о docs-markdown

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

Файл правила кладётся в проект по пути .claude/rules/docs-markdown.md.

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

Задаёт пять требований к markdown-документации: запускаемые примеры команд, пути от корня, соответствие описания архитектуры коду, обновление всех затронутых доков разом и короткие разделы с конкретным траблшутингом.

На какие файлы действует правило?

На markdown: в шапке прописан paths: **/*.md. Исходный код и конфиги правило не проверяет.

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

docs-markdown.md · MIT
---
paths:
  - "**/*.md"
---

# Documentation Rules

- Keep command examples executable and aligned with actual scripts.
- Use absolute or clearly rooted paths when discussing project files.
- When adding architecture claims, reflect current code behavior.
- Update all affected docs together (`README.md` landing, `README-EN.md` full guide and mirrors, `ARCHITECTURE`, `SETUP`, `INSTALL`, `mcp/README`) when workflows change.
- Prefer concise sections and concrete troubleshooting steps.

© hoangsonww · MIT · hoangsonww/Claude-Code-Agent-Monitor

Похожие правила IDE

Все правила IDE по теме «Тексты и документация» →
markdown-documentation aj-geddes Скилл markdown-documentation для Claude Code задаёт агенту правила оформления Markdown: README, вики, страницы документации. Приводит тексты, которые пишет модель, к единому виду. CX Codex +1 1 300установок markdown-formatter markpitt Скилл markdown-formatter приводит markdown-файлы к единому стилю: заголовки, списки, блоки кода, ссылки, пробелы. Проверяет результат скриптом и показывает, что исправлено. CX Codex +1 245установок markdown-style JosiahSiegel Скилл markdown-style проверяет Markdown в два прохода: сначала синтаксис по канону, потом стиль. Показывает находки построчно и правит только то, что вы одобрили. CX Codex +1 125установок ns-docs-writer nextstage-brasil Скилл ns-docs-writer для Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode, который пишет человекочитаемую документацию проекта: README, руководства в docs/, ранбуки и инструкции для контрибьюторов. CX Codex +1 151установок update-docs-on-code-change официальный github Правило update-docs-on-code-change для GitHub Copilot, которое обновляет README.md и другие файлы документации при изменении кода. Срабатывает, когда новые функции, изменения API или зависимостей требуют правок в описаниях. CX Codex +1 ★ 41 430звёзд репо docs-starter-kit patricio0312rev Скилл docs-starter-kit генерирует комплект проектной документации: файлы README, CONTRIBUTING, SECURITY, лицензию и правила поведения для открытых и закрытых репозиториев. CX Codex +1 265установок

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

Весь набор →
ccam-productivity Хук ccam-productivity для Claude Code и Codex записывает в лог-файл метки начала и конца сессии Claude Code. По ним можно замерять длительность работы над задачами. CX Codex ★ 1 198звёзд репо ccam-cost-guard Хук ccam-cost-guard отслеживает расходы на Claude Code и отправляет данные о завершении сессий в дашборд Agent Monitor. CX Codex ★ 1 198звёзд репо ccam-analytics Хук ccam-analytics для Claude Code собирает телеметрию сессий и передаёт события завершения в Agent Monitor. Срабатывает автоматически при остановке сессии или субагента. CX Codex ★ 1 198звёзд репо integration-operator Субагент integration-operator управляет оповещениями, вебхуками, push-уведомлениями и SSH-источниками в CCAM. Требует подтверждения записей и скрывает секреты. CX Codex ★ 1 198звёзд репо backend-reviewer Субагент backend-reviewer проверяет маршруты и хуки на регрессии, риски для данных и пробелы в тестах. Подключается к Claude Code и Codex. CX Codex ★ 1 198звёзд репо frontend-react Правило frontend-react для React-фронтенда: держит правки интерфейса узкими — явные типы пропсов, готовые паттерны состояний, маршруты без переделки. CX Codex +1 ★ 1 198звёзд репо platform-admin Субагент platform-admin управляет настройками, хуками, импортом, резервными копиями и MCP в Claude Code Agent Monitor. Проверяет изменения через дашборд. CX Codex ★ 1 198звёзд репо frontend-reviewer Субагент Claude Code frontend-reviewer проверяет изменения в React-интерфейсе на поломки поведения, рассинхрон состояния и ошибки UX. Проводит ревью UI после правок. CX Codex ★ 1 198звёзд репо

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

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