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
- Discover — list existing
docs/, README, andAGENTS.mdlinks; avoid duplicating harness/brownfield artifacts (link instead). - Audience — confirm developer vs operator vs end-user (default: developer).
- Outline — short TOC before drafting long guides.
- Draft — follow
references/style-guide.md. - 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.mdlayout tablearchitecture-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.mdorsystem-reverse-spec.mdinto 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.mdand legacydocs/versions/*/requirements.md— link canonicalsdd/path only; never create or maintain dual trees