mcpField
N
ns-code-docs-writer

ns-code-docs-writer

github.com/nextstage-brasilDocuments054 installsUpdated 5d ago
Repository

About ns-code-docs-writer

ns-code-docs-writer is a skill for developers who need to write or maintain project documentation in README files and docs/. It provides a workflow that checks existing project guidance and documentation structure before drafting.

Key features

  1. 01README 与 docs/ 文档撰写
  2. 02检查现有文档与项目指引
  3. 03按受众规划和起草文档
  4. 04使用相对链接连接规范

Use cases

  1. 01为新功能编写用户或开发者文档
  2. 02结构调整后更新过时的 README
  3. 03整理贡献者入门指南
  4. 04将分散笔记整合到 docs/

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/nextstage-brasil/skills --skill ns-code-docs-writer

After installing, type/ns-code-docs-writerin Claude Code to confirm it loaded.

Bundled filesevals/evals.jsonreferences/style-guide.md

Details

From the project README

Docs Writer

Author clear, maintainable project documentation under docs/ and README files.

Harness discovery

See ../ns-harness/references/harness-discovery.md. Resolve {product_root} from AGENTS.md.

Scope

In scopeOut of scope
README.md at product or repo rootInline // or /** code comments
docs/**/*.md guidesdocs/versions/*/requirements.md
Runbooks, install guides, architecture overviews for humansLiving specs in docs/specs/ (use ns-sdd-living-spec-consolidator)
Changelog entries when requestedMarketing 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.

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

Comments

Markdown supported