team-docs — скилл для Claude Code: документация и установка
Скилл team-docs для Claude Code задаёт методику написания технической документации. Он включается при подготовке README, руководств по использованию, документации API и заметок об архитектуре.
MIT ★ 71 обновлён 2026-11-13
npx skills add sametcelikbicak/opencode-team --skill team-docs -a claude-codeЧто делает 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-code2Вручную: положить файлы
~/.claude/skills/team-docs/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/team-docs/
1Через Skills CLI (Vercel)
npx skills add sametcelikbicak/opencode-team --skill team-docs -a codex2Вручную: положить файлы
.agents/skills/team-docs/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add sametcelikbicak/opencode-team --skill team-docs -a cursor2Вручную: положить файлы
.cursor/skills/team-docs/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install sametcelikbicak/opencode-team skills/team-docs2Вручную: положить файлы
.github/skills/team-docs/SKILL.md1Через Skills CLI (Vercel)
npx skills add sametcelikbicak/opencode-team --skill team-docs -a gemini-cli2Командой платформы
gemini skills install https://github.com/sametcelikbicak/opencode-team --path skills/team-docsВручную: положить файлы
.devin/skills/team-docs/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Claude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в 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