team-docs — Claude Code skill for technical docs
team-docs is a Claude Code skill for writing technical documentation. It guides work on README files, API references, usage guides, and architecture notes.
MIT ★ 71 updated 2026-11-13
npx skills add sametcelikbicak/opencode-team --skill team-docs -a claude-codeWhat team-docs does
team-docs provides a workflow for project READMEs, API references, and short records of architecture decisions. Its README outline covers installation, usage, development, tests, and deployment. Commands must be run before they appear in the docs; working output can be included, while a failing command must be fixed or removed.
For API docs, the skill uses a table for methods, paths, authentication, request bodies, responses, and errors, with an example for each endpoint. Architecture notes capture the decision context, chosen option, alternatives, and consequences. Write README files, API docs, code examples, and comments in English. If a section cannot be verified, leave it out and report it as “unverifiable.”
What it helps with
- draft a README with installation and test sections
- verify commands before documenting them
- describe API endpoints with request and response examples
- record an architecture decision and its alternatives
Example prompts for the agent
- Write a project README and run each command before documenting it.
- Document the API endpoints with request, response, and error examples.
- Draft an architecture note covering the decision context and alternatives.
How to install team-docs
1Skills CLI (Vercel)
npx skills add sametcelikbicak/opencode-team --skill team-docs -a claude-code2Manually: put the files in place
~/.claude/skills/team-docs/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/team-docs/
1Skills CLI (Vercel)
npx skills add sametcelikbicak/opencode-team --skill team-docs -a codex2Manually: put the files in place
.agents/skills/team-docs/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add sametcelikbicak/opencode-team --skill team-docs -a cursor2Manually: put the files in place
.cursor/skills/team-docs/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install sametcelikbicak/opencode-team skills/team-docs2Manually: put the files in place
.github/skills/team-docs/SKILL.md1Skills CLI (Vercel)
npx skills add sametcelikbicak/opencode-team --skill team-docs -a gemini-cli2Platform CLI
gemini skills install https://github.com/sametcelikbicak/opencode-team --path skills/team-docsManually: put the files in place
.devin/skills/team-docs/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about team-docs
How do I install team-docs in Claude Code?
Run npx skills add sametcelikbicak/opencode-team --skill team-docs -a claude-code. The skill file is at ~/.claude/skills/team-docs/SKILL.md.
What does team-docs do?
It guides the writing of README files, API documentation, and architecture notes. Its workflow requires command checks and uses English for docs, code examples, and comments.
What language should documentation use with team-docs?
Write README files, API documentation, code examples, and comments in English.
Source text
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