docs-markdown — правило для Claude Code: что делает и как установить
Правило docs-markdown задаёт требования к markdown-документам проекта: рабочие примеры команд, пути от корня и синхронное обновление всех README, когда меняются процессы.
MIT ★ 1 198 обновлён 2026-10-23
.claude/rules/docs-markdown.mdЧто делает 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
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.cursor/rules/docs-markdown.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.github/instructions/docs-markdown.instructions.mdПоле applyTo задаёт, к каким файлам применять
Вручную: положить файлы
.devin/rules/docs-markdown.mdВручную: положить файлы
.clinerules/docs-markdown.mdПо шагам, с командами для каждой платформы: 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