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

build-workspace-docs — скилл для Claude Code: что делает и установка

Скилл build-workspace-docs синхронизирует README.md и WORK_AREAS.md с каталогом скиллов. Нужен после изменений в библиотеке или перед коммитом.

MIT 172 установок ★ 1 161 обновлён 2026-09-21

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a claude-code
Открыть на GitHub

Что делает build-workspace-docs

Скилл обновляет сгенерированные разделы README.md и WORK_AREAS.md в рабочем пространстве библиотеки. Сначала он запускает просмотр изменений через --dry-run, затем пересобирает документы командой build-docs. Результат можно получить в JSON для автоматизированного пайплайна.

Работать нужно из инициализированного рабочего пространства с файлом .ai-agent-skills/config.json. Без этого файла команда завершится ошибкой. Сгенерированные секции нельзя править вручную: их границы задают HTML-комментарии <!-- GENERATED:...:start/end -->. Проверку актуальности docs даёт поле currentlyInSync в JSON-выводе.

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

  • синхронизировать README.md с каталогом скиллов
  • пересобрать WORK_AREAS.md после добавления скиллов
  • просмотреть изменения перед записью документов
  • проверить актуальность документации в JSON
  • подготовить docs перед коммитом в git

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

  • Проверь, что изменится в документации рабочего пространства, через build-docs --dry-run.
  • Пересобери README.md и WORK_AREAS.md после изменения каталога скиллов.
  • Проверь результат в JSON и сообщи значение currentlyInSync.

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

1Через Skills CLI (Vercel)

npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a claude-code

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

~/.claude/skills/build-workspace-docs/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/build-workspace-docs/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о build-workspace-docs

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

Выполните npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a claude-code. Скилл появится по пути ~/.claude/skills/build-workspace-docs/SKILL.md.

Что делает build-workspace-docs?

Он синхронизирует README.md и WORK_AREAS.md с каталогом скиллов: сначала показывает план изменений, затем пересобирает документы и может вернуть структурированный JSON.

Где запускать build-workspace-docs?

Только внутри инициализированного рабочего пространства с .ai-agent-skills/config.json. Сначала используйте --dry-run, а сгенерированные секции не редактируйте вручную.

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

SKILL.md · MIT
---
name: build-workspace-docs
description: Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.
category: workflow
version: 4.1.0
---

# Build Workspace Docs

## Goal

Keep workspace documentation in sync with the skills catalog after adding, removing, or curating skills.

## Guardrails

- Always use `--dry-run` before regenerating docs to preview what will change.
- Only run from inside an initialized library workspace (a directory with `.ai-agent-skills/config.json`).
- Never hand-edit the generated sections of README.md or WORK_AREAS.md. The CLI will overwrite them.
- Use `--format json` to capture structured results for automation pipelines.

## Workflow

1. Preview what would change.

```bash
npx ai-agent-skills build-docs --dry-run
```

2. Regenerate the docs.

```bash
npx ai-agent-skills build-docs
```

3. Verify the output.

```bash
npx ai-agent-skills build-docs --dry-run --format json
```

The JSON output includes `currentlyInSync` to tell you whether docs were already up to date.

## When to Run

- After `add`, `catalog`, `vendor`, or `curate` commands that change the skills catalog.
- After bulk imports from a remote library.
- Before committing workspace changes to git.

## Gotchas

- Running outside a workspace will fail with a clear error. Use `init-library` to create one first.
- The generated docs use HTML comment markers (`<!-- GENERATED:...:start/end -->`) as boundaries. Do not remove these markers from the template sections.

© MoizIbnYousaf · MIT · MoizIbnYousaf/ai-agent-skills

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
absolute-docs dhruvjainin Скилл absolute-docs для Claude Code структурирует техническую документацию по методологии Diátaxis. Помогает писать руководства, справочники, README и проводить аудит существующих страниц. CX Codex +1 171установок docs-voice devvmhq Скилл docs-voice для Claude Code переписывает документацию devvm ясным языком, сохраняя факты. Включается при написании и редактировании страниц, README, справки команд и сообщений CLI. CX Codex +1 ★ 738звёзд репо docs-guard amElnagdy Скилл docs-guard проверяет документацию, README и докстринги на соответствие коду проекта. Находит выдуманные сигнатуры и удаляет пустые формулировки. CX Codex +1 4 200установок docs-updater giuseppe-trisciuoglio Скилл docs-updater для Claude Code анализирует изменения Git и обновляет документацию проекта. Запускается при подготовке релиза, синхронизации README или перед pull request. CX Codex +1 3 700установок update-docs NeoLabHQ Скилл update-docs анализирует изменения в коде через git и обновляет README, файлы docs/ или JSDoc. Помогает поддерживать документацию проекта без ручного переписывания. CX Codex +1 1 400установок review-docs zernie Скилл review-docs для Claude Code параллельно проверяет README или страницу документации глазами разных читателей и предлагает оценки и правки по конкретным строкам. CX Codex +1 626установок

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

Весь набор →
llm-application-dev Скилл llm-application-dev для работы с большими языковыми моделями на Claude Code, Codex, Cursor и других платформах. CX Codex +1 467установок ask-questions-if-underspecified Скилл ask-questions-if-underspecified заставляет агента задать 1–5 уточняющих вопросов до начала работы, чтобы не переделывать её потом. Вызывается вручную. CX Codex +1 383установок browse-and-evaluate Скилл browse-and-evaluate помогает найти, сравнить и проверить скиллы каталога до установки. Подходит, когда нужно просмотреть варианты без лишнего вывода. CX Codex +1 177установок review-a-skill Скилл review-a-skill для Claude Code проверяет скилл перед добавлением в библиотеку: метаданные, структуру, безопасность и зависимости. Помогает решить, оставить его, доработать или удалить. CX Codex +1 177установок audit-library-health Скилл audit-library-health для комплексной диагностики библиотеки скиллов: валидация структуры, поиск устаревших элементов, проверка синхронизации документации. Запускайте перед публикацией или обновлением. CX Codex +1 170установок update-installed-skills Скилл update-installed-skills для Claude Code синхронизирует установленные скиллы с новыми версиями в репозиториях. Перед синхронизацией проверяет обновления через dry-run; локальные правки нужно сохранить отдельно. CX Codex +1 168установок share-a-library Скилл share-a-library автоматизирует публикацию готовой локальной библиотеки на GitHub и генерирует команду установки для товарищей по команде. CX Codex +1 161установок install-from-remote-library Скилл install-from-remote-library помогает безопасно ставить скиллы из общих репозиториев. Сначала изучает состав каталога и запускает тестовый прогон через --dry-run. CX Codex +1 161установок

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

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