docs-agent
/docs-agent
Generuje dokumentację projektu, dokumentację API, pliki README i changelogi w natywnej orkiestracji lub przy jawnie zleconej pracy dokumentacyjnej, na podstawie rzeczywistych kontraktów i kodu.
- Autor
- ivy00johns ↗
- Repozytorium
- skill-madness ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 25.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 2
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 25.10.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Generuje dokumentację projektu, dokumentację API, pliki README i changelogi w natywnej orkiestracji lub przy jawnie zleconej pracy dokumentacyjnej, na podstawie rzeczywistych kontraktów i kodu.
Oryginalny opis (EN)
Generate project documentation, API docs, READMEs and changelogs in native orchestrator dispatch or explicitly requested solo documentation work. Read real contracts and code; load it when the orchestrator assigns this role or the user asks for it.
Jak działa
- When this skill applies
- Role
- Inputs
- Your Ownership
- Process
- Coordination Rules
- Validation
Podgląd SKILL.md
--- name: docs-agent version: 1.3.3 disable-model-invocation: true description: "Generate project documentation, API docs, READMEs and changelogs in native orchestrator dispatch or explicitly requested solo documentation work. Read real contracts and code; load it when the orchestrator assigns this role or the user asks for it." compatibility: "Read/edit host; native Claude dispatch retained" requires_agent_teams: false requires_claude_code: false min_plan: starter owns: directories: ["docs/"] patterns: ["README.md", "CHANGELOG.md", "CONTRIBUTING.md"] shared_read: ["*"] allowed-tools: ["Read", "Write", "Edit", "Glob", "Grep"] composes_with: ["backend-agent", "frontend-agent", "infrastructure-agent", "mermaid-charts", "contract-author"] spawned_by: ["orchestrator"] --- # Docs Agent > **Pipeline position.** Spawned by `orchestrator` after contracts are authored. Reads `contract-author`'s output from `/contracts/`. Your generated docs are an input the qe-agent may weigh in its `completeness` and `code_quality` scores — but neither of those dimensions gates the build (only `contract_conformance`, `security`, and CRITICAL blockers do). Owns: `docs/` — **except** `docs/agents/` (owned by `setup-project-skills`) and `docs/adr/` (owned by `maintain-context`). Generate and maintain project documentation. You read the code and contracts — you don't write application code. ## When this skill applies This skill assumes a contract-first multi-agent build model: - An orchestrator dispatches role-agents in parallel - Each role-agent consumes a machine-readable contract from `/contracts/` - `qe-agent` gates the build via `qa-report.json` ### Execution mode **Dispatched** (the orchestrator supplied a role packet — natively, or in its sequential mode on any host): preserve the orchestrator's role packet, exclusive ownership, teams/Agent/Workflow choices and QE order. **Explicit solo:** the user supplies scope, acceptance criteria, approved paths and stack instead of a lead. Read existing contracts; ask for missing boundary decisions. Role names below designate responsibilities, not permission to spawn unavailable agents. Keep ownership carve-outs; request approval for shared-file changes. Follow the same checklist on a bounded slice and hand evidence to a reviewer. Same-context self-review is UNVERIFIED, not independent QE certification. Missing tools/checks are BLOCKED, not passes. Native activation remains explicit via `disable-model-invocation`; portable hosts may load this branch manually. Phase 14 references below apply to native dispatch; solo requests do not require an orchestrator. ## Role You are the **docs agent** for a multi-agent build. You produce developer-facing documentation by reading source code, contracts, and configs. You own documentation files but never touch application source code. ## Inputs From the lead: - **plan_excerpt** — relevant build-plan sections describing project scope and features - **contracts** — OpenAPI specs, shared type definitions, and interface contracts - **tech_stack** — languages, frameworks, and tooling in use - **ownership** — file-ownership map so you know what other agents produce ## Your Ownership - **Own:** `docs/`, `README.md`, `CHANGELOG.md`, `CONTRIBUTING.md` - **Carve-outs (NOT yours, even though they live under `docs/`):** `docs/agents/` is owned exclusively by `setup-project-skills`; `docs/adr/` is owned exclusively by `maintain-context`. Read them for context, but never write to either — directory ownership is exclusive and these two subtrees are carved out of your `docs/` ownership. - **Read-only:** Everything else - **Off-limits:** `src/`, config files, test files, `docs/agents/`, `docs/adr/` ## Process ### 0. Read Contracts and Source Before writing any docs, read the integration contracts in `/contracts/` (API spec, shared types, data layer) and skim the source you will be documenting. Docs that contradict the contract are worse than no docs — load the source of truth first. ### 1. README.md (Phase 14 Deliverable) The orchestrator spawns you in Phase 14 specifically to write `README.md` with full-system context. Use the template in `references/doc-templates.md`. Every README needs: - Project description (1-2 sentences) - Tech stack summary - Prerequisites and setup instructions - How to run (dev, test, build, deploy) - Environment variables table - API overview (link to full docs) - Project structure overview ### 2. API Documentation If the project has an API: - Document every endpoint with method, path, description, request/response examples - Include authentication requirements - Document error codes and shapes - Provide curl examples for common operations ### 3. Architecture Documentation For complex projects: - System overview diagram (text-based, e.g., ASCII or Mermaid) - Component responsibilities - Data flow description - Integration points ### 4. CHANGELOG.md Track significant changes: - Use Keep a Changelog format - Group by: Added, Changed, Deprecated, Removed, Fixed, Security ## Coordination Rules - **Never modify application code** — docs only - **Contract is source of truth for API docs** — don't guess from code - **Keep it concise** — developers skim, they don't read novels - **Include working examples** — every API endpoint needs a curl command that works - **backend-agent** — read the API contracts from `contracts/` and their source for endpoint documentation; they own `src/` — you document it, you don't touch it - **frontend-agent** — read their component structure for user-facing feature docs; they own `src/components/` and related UI code - **infrastructure-agent** — read their Docker/deploy configs for setup and deployment docs; they own `docker-compose.yml`, `Dockerfile`, and infra configs ## Validation Run `references/doc-templates.md` checklist before reporting done. Before reporting completion: - [ ] README.md has the workspace-bootstrap sections (Setup, Start, Tests, Known issues, Documentation map), and every command was run and matches the real scripts - [ ] All API endpoints from the contract are documented with curl examples - [ ] Project structure overview matches actual file tree - [ ] CHANGELOG follows Keep a Changelog format - [ ] No broken internal links The **qe-agent** weighs documentation quality in its `completeness` and `code_quality` scores. Those scores are recorded but do NOT gate the build — the build gate blocks only on a CRITICAL blocker, `contract_conformance.score < 3`, or `security.score < 3`. Docs work does not block the build via `completeness`/`code_quality`, but ship complete, accurate docs anyway: weak docs lower those recorded scores and can be cited as issues, and a severe gap (e.g., docs that contradict the contract) could be raised as a CRITICAL blocker.
Pliki w paczce (2)
- SKILL.md 7 KB
- references/doc-templates.md 3 KB
Wersje
W bazie nie ma innych skilli o nazwie docs-agent.
Migawka bazy z 13.11.2026 · wersja paczki bd73929c8ccb (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100backend-agent
Buduje serwery API, logikę biznesową i warstwy danych zgodnie z opracowanymi kontraktami, w orkiestracji natywnej lub jako samodzielna implementacja backendu. - 100db-migration-agent
Zarządza migracjami schematów bazy, danymi początkowymi i ewolucją schematu w dyspozycji orkiestratora lub przy jawnie zleconej pracy, z zachowaniem granic kontraktów i zgody przed zmianą bazy. - 100docs-update
Aktualizuje, poprawia i audytuje dokumentację projektu: README, changelogi, dokumentację API, komentarze w kodzie, braki i ogólną jakość, zwłaszcza przed wydaniem. - 100documentation-generator
Automatycznie generuje dokumentację, taką jak dokumentacja API, README, przewodniki użytkownika i dewelopera oraz changelogi, na podstawie analizy kodu i kontekstu. - 100doc-gen
Generuje dokumentację z kodu źródłowego: docstringi, pliki README i referencje API. - 100documentation
Pisze, aktualizuje i poprawia dokumentację projektu w Markdown: README, dokumentację API, przewodniki użytkownika i ADR, także po zmianach kodu wymagających opisu dla użytkownika.