ns-docs-writer — скилл для Claude Code, Codex, Cursor: README и docs/
Скилл ns-docs-writer для Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode, который пишет человекочитаемую документацию проекта: README, руководства в docs/, ранбуки и инструкции для контрибьюторов.
Apache-2.0 151 установок обновлён 2026-10-24
npx skills add nextstage-brasil/skills --skill ns-docs-writer -a claude-codeЧто делает ns-docs-writer
Скилл работает на шести платформах: Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode. На каждой он устанавливается через npx skills add nextstage-brasil/skills --skill ns-docs-writer с флагом платформы, после чего файл SKILL.md появляется в соответствующей папке агента.
Перед драфтом скилл обходит существующие docs/, README и AGENTS.md, чтобы не дублировать то, что уже есть, а поставить ссылку. Аудитория уточняется по умолчанию как «разработчик»; структура папок выводится из AGENTS.md или architecture-rules.md — скилл не предполагает монорепо с packages/. Черновик следует references/style-guide.md из репозитория.
Скилл версии 1.4 зависит от ns-harness: без него сессия не загрузится. Код-комментарии, блоки /** */, requirements.md и артефакты SDD — вне его области, для них нужны PM-скиллы.
Какие задачи решает
- Написать README после структурных изменений в репозитории
- Собрать ранбук или install guide для операторов
- Создать онбординг-гайд для новых контрибьюторов
- Сконсолидировать разрозненные заметки в
docs/ - Задокументировать архитектуру агента в
docs/specs/agent-architecture.md
Примеры запросов агенту
- Напиши README для корня репозитория с учётом последних изменений
- Создай ранбук в
docs/для деплоя сервиса на staging - Обнови раздел Contributing в README и добавь onboarding-гайд для контрибьюторов
Как установить ns-docs-writer
1Через Skills CLI (Vercel)
npx skills add nextstage-brasil/skills --skill ns-docs-writer -a claude-code2Вручную: положить файлы
~/.claude/skills/ns-docs-writer/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/ns-docs-writer/
1Через Skills CLI (Vercel)
npx skills add nextstage-brasil/skills --skill ns-docs-writer -a codex2Вручную: положить файлы
.agents/skills/ns-docs-writer/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add nextstage-brasil/skills --skill ns-docs-writer -a cursor2Вручную: положить файлы
.cursor/skills/ns-docs-writer/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install nextstage-brasil/skills skills/ns-docs-writer2Вручную: положить файлы
.github/skills/ns-docs-writer/SKILL.md1Через Skills CLI (Vercel)
npx skills add nextstage-brasil/skills --skill ns-docs-writer -a gemini-cli2Командой платформы
gemini skills install https://github.com/nextstage-brasil/skills --path skills/ns-docs-writerВручную: положить файлы
.devin/skills/ns-docs-writer/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add nextstage-brasil/skills --skill ns-docs-writer -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о ns-docs-writer
Как установить ns-docs-writer в Claude Code?
Выполните npx skills add nextstage-brasil/skills --skill ns-docs-writer -a claude-code — скилл появится по пути ~/.claude/skills/ns-docs-writer/SKILL.md.
Что делает скилл ns-docs-writer?
Он генерирует человекочитаемую документацию: README, руководства в docs/, ранбуки и материалы для контрибьюторов. Код-комментарии и спецификации SDD в его область не входят.
Зачем нужен ns-harness и что будет без него?
ns-docs-writer зависит от ns-harness — без этого скилла сессионная загрузка (session-boot.md) не выполнится и скилл не запустится.
Исходный текст
SKILL.md · Apache-2.0
--- name: ns-docs-writer description: "(NS) Human-facing project docs — README, docs/ guides, runbooks, contributor markdown. Use whenever the user asks for documentation, README updates, how-to guides, or docs/ content — even if they say \"explain how to use\" instead of \"write docs\". Do NOT use for code comments, API docblocks, requirements.md, or SDD version artifacts (use PM skills)." license: Apache-2.0 metadata: author: nextstage-brasil version: "1.4" depends: - ns-harness --- # Docs Writer Author **clear, maintainable** project documentation under `docs/` and README files. ## Session boot See `../../ns-harness/references/session-boot.md`. ## Scope | In scope | Out of scope | | -------- | ------------ | | `README.md` at product or repo root | Inline `//` or `/**` code comments | | `docs/**/*.md` guides | `docs/versions/*/sdd/requirements.md`, `docs/versions/*/requirements.md` (legacy SDD) | | Runbooks, install guides, architecture overviews for humans | Living specs in `docs/specs/` (use `ns-living-spec`) | | Changelog entries when requested | Marketing copy outside repo | ## When to use - New feature needs user or developer documentation - README is stale after structural changes - Onboarding guide for contributors - Consolidating scattered notes into `docs/` ## Workflow 1. **Discover** — list existing `docs/`, README, and `AGENTS.md` links; avoid duplicating harness/brownfield artifacts (link instead). 2. **Audience** — confirm developer vs operator vs end-user (default: developer). 3. **Outline** — short TOC before drafting long guides. 4. **Draft** — follow `references/style-guide.md`. 5. **Link** — prefer relative links; point to canonical rules in `.nextstage-harness/rules/` when relevant. ## Layout (stack-agnostic) Do not assume monorepo `packages/` layout. Infer from: - `AGENTS.md` layout table - `architecture-rules.md` - Existing `docs/` structure Create subfolders only when they match project convention. ## Integration When called from `ns-spec-driven`, document **delivered behavior** — do not invent requirements. Agent **why** (reference architecture, agent vs code, trade-offs, topology, HITL, change signal) lives in `docs/specs/agent-architecture.md`. Link it. Do not copy the interview or rewrite the decision record in README. `docs/specs/agent.md` is behavior (`ns-living-spec`), not this ADR. ## Forbidden - Copying full bodies of `brownfield-map.md` or `system-reverse-spec.md` into new docs (link them) - English violations when project mandates English docs - Auto-generating docs for code that does not exist yet - Same version with both `docs/versions/*/sdd/requirements.md` and legacy `docs/versions/*/requirements.md` — link canonical `sdd/` path only; never create or maintain dual trees
© nextstage-brasil · Apache-2.0 · nextstage-brasil/skills