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

team-docs — скилл для Claude Code: документация и установка

Скилл team-docs для Claude Code задаёт методику написания технической документации. Он включается при подготовке README, руководств по использованию, документации API и заметок об архитектуре.

MIT ★ 71 обновлён 2026-11-13

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

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

team-docs помогает писать README, документацию API и короткие заметки об архитектурных решениях. Для README он задаёт структуру с разделами установки, использования, разработки, тестирования и развёртывания. Команды в документации нужно сначала запустить: работающий вывод добавляется в README, а неработающую команду исправляют или удаляют.

Для API предусмотрены таблица методов, путей, авторизации, тел запросов, ответов и ошибок, а также примеры для конечных точек. Заметка об архитектуре фиксирует контекст решения, выбранный вариант, альтернативы и последствия. Документацию, примеры кода и комментарии пишут на английском. Если раздел нельзя проверить, его не добавляют и отмечают как «unverifiable».

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

  • составить README с разделами установки и тестирования
  • проверить команды перед добавлением в документацию
  • описать API с примерами запросов и ответов
  • зафиксировать архитектурное решение и альтернативы

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

  • Подготовь README для проекта и проверь команды перед тем, как добавить их.
  • Опиши конечные точки API с примерами запросов, ответов и ошибок.
  • Составь заметку об архитектурном решении с контекстом и альтернативами.

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

1Через Skills CLI (Vercel)

npx skills add sametcelikbicak/opencode-team --skill team-docs -a claude-code

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

~/.claude/skills/team-docs/SKILL.md

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

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

Вопросы о team-docs

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

Выполни npx skills add sametcelikbicak/opencode-team --skill team-docs -a claude-code. Файл скилла находится по пути ~/.claude/skills/team-docs/SKILL.md.

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

Скилл задаёт правила для README, документации API и заметок об архитектуре. Он требует проверять команды и писать документацию, примеры кода и комментарии на английском.

На каком языке team-docs предлагает писать документацию?

README, документацию API, примеры кода и комментарии нужно писать на английском.

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

SKILL.md · MIT
---
name: team-docs
description: Technical documentation writing methodology. README, usage guide, API documentation and architecture note. The playbook of the docs role.
---

# Technical Documentation

## Core principle

**Verify everything you document.** Do not write it if you have not run the command. Do not write it if you have not read the code. Wrong documentation is worse than no documentation — the user looks in the wrong direction.

## README template

```markdown
# Project Name

One sentence: what it does.

## Installation
## Usage
## Development
## Test
## Deployment
## Architecture (short)
## Contributing
## License
```

Rules:
- Every command in a **copyable** block
- Prerequisites (runtime version, required tools) stated explicitly
- "Requirements" section with version numbers (Node 20+)
- A project explainable in 5 lines should have a 5-line README. An overly long README is a badly written README.

## Verification loop

For every command:

1. **Run** the command.
2. If it works, write its output into the README.
3. If it does not work, either fix it or remove it from the README.

If you cannot do this, do not write that section of the README and report it as "unverifiable".

## API documentation

| Method | Path | Auth | Body | Response | Errors |
|---|---|---|---|---|---|

An example for each endpoint:

**POST /api/v1/invoices**

```http
POST /api/v1/invoices
Content-Type: application/json
Authorization: Bearer <token>
```

```json
{ "number": "INV-2026-001", "total": 249.90, "currency": "EUR" }
```

**201 Created**

```json
{ "id": "inv_01H...", "number": "INV-2026-001", "total": 249.90, "currency": "EUR" }
```

The error body format and a list of error codes (400 / 401 / 403 / 404 / 422 / 500).

## Architecture note

A short ADR-like note:

```markdown
## Decision: <topic>
**Context:** <why this decision is needed>
**Decision:** <what we are doing>
**Alternatives:** <the ones not chosen and why>
**Consequences:** <the benefit and the cost>
```

Do not write more than 10 decisions. Write the 5-10 most impactful ones.

## Language rule

README, API documentation, code examples, comments → **English**.

## Common mistakes

| Mistake | The right way |
|---|---|
| Writing a command you have not run | Run it or do not write it |
| Badge, emoji and "Built with" clutter | Only information that is useful |
| "See the docs for details" | Write the detail |
| Repeating the same information everywhere | One source, link to it |
| Leaving outdated documentation around | Update or delete it |

## Output format

A list of the files written/updated + what was added to each file. Also a list of the points that could not be documented and what is still missing.

© sametcelikbicak · MIT · sametcelikbicak/opencode-team

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

Все скиллы по теме «Тексты и документация» →
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установок docs-starter-kit patricio0312rev Скилл docs-starter-kit генерирует комплект проектной документации: файлы README, CONTRIBUTING, SECURITY, лицензию и правила поведения для открытых и закрытых репозиториев. CX Codex +1 265установок absolute-docs dhruvjainin Скилл absolute-docs для Claude Code структурирует техническую документацию по методологии Diátaxis. Помогает писать руководства, справочники, README и проводить аудит существующих страниц. CX Codex +1 171установок

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

Весь набор →
be Субагент be для Claude Code реализует backend API, базы данных и тесты по готовой архитектуре. Результаты работы фиксируются в файле отчёта .team/07-build-be.md. CX Codex ★ 71звёзд репо fe Субагент fe для Claude Code реализует интерфейс, компоненты и адаптивную вёрстку. Он пишет тесты и отчёт по фронтенд-задаче, назначенной оркестратором. CX Codex ★ 71звёзд репо brand Субагент brand для Claude Code разрабатывает логотипы и айдентику проекта. Он ведёт задачу от брифа и SVG-концептов до набора фавиконок и брендбука. CX Codex ★ 71звёзд репо orchestrator Субагент orchestrator для Claude Code ведёт идею по этапам от исследования до запуска. Он распределяет работу между специалистами и ждёт подтверждения перед переходом дальше. CX Codex ★ 71звёзд репо team-prd Скилл team-prd для Claude Code структурирует составление продуктовых требований к первой версии продукта. Задаёт границы скоупа и проверяемые критерии приёмки. CX Codex +1 ★ 71звёзд репо team-qa Скилл team-qa для Claude Code превращает критерии приёмки в тесты и задаёт стратегию QA. Он помогает проверить граничные случаи, основные пользовательские сценарии и найденные баги. CX Codex +1 ★ 71звёзд репо team-ux Скилл team-ux для Claude Code составляет UX-спецификации интерфейсов без кода: описывает сценарии экранов, состояния, доступность по WCAG 2.1 AA и поведение на мобильных устройствах. CX Codex +1 ★ 71звёзд репо team-marketing Скилл team-marketing для Claude Code помогает спланировать маркетинг и запуск продукта: от позиционирования до календаря публикаций. Он подключается к задачам по подготовке сообщений, каналов продвижения и измеримых метрик. CX Codex +1 ★ 71звёзд репо

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

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