ns-docs-writer

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Docs Writer

文档撰写者

Author clear, maintainable project documentation under

docs/

and README files.

撰写清晰、易维护的项目文档，存放于

docs/

目录和README文件中。

Session boot

会话启动

See

../../ns-harness/references/session-boot.md

详见

../../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/*/requirements.md`
Runbooks, install guides, architecture overviews for humans	Living specs in `docs/specs/` (use `ns-living-spec` )
Changelog entries when requested	Marketing copy outside repo

包含范围	排除范围
产品或仓库根目录下的 `README.md`	行内 `//` 或 `/**` 代码注释
`docs/*/.md` 格式的指南	`docs/versions/*/requirements.md`
面向用户的运行手册、安装指南、架构概述	`docs/specs/` 中的动态规范（使用 `ns-living-spec` ）
按需编写的变更日志条目	仓库外的营销文案

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/
```

新功能需要用户或开发者文档
结构变更后README已过时
贡献者入门指南
将零散笔记整合到
```
docs/
```
中

Workflow

工作流程

Discover — list existing
```
docs/
```
, README, and
```
AGENTS.md
```
links; 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.

调研——列出现有
```
docs/
```
、README和
```
AGENTS.md
```
的链接；避免重复已有工件（改为链接）。
受众确认——确认受众是开发者、运维人员还是终端用户（默认：开发者）。
大纲——撰写长篇指南前先制作简短目录。
撰写——遵循
```
references/style-guide.md
```
。
链接——优先使用相对链接；相关时指向
```
.nextstage-harness/rules/
```
中的规范规则。

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.

不要假设单仓库

packages/

布局。从以下文件推断：

```
AGENTS.md
```
中的布局表
```
architecture-rules.md
```
现有
```
docs/
```
结构

仅当符合项目惯例时才创建子文件夹。

Integration

集成

When called from

ns-spec-driven

, document delivered behavior — do not invent requirements.

当被

ns-spec-driven

调用时，记录已交付的功能——不要凭空创造需求。

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

将
```
brownfield-map.md
```
或
```
system-reverse-spec.md
```
的完整内容复制到新文档中（改为链接）
若项目要求文档使用英文，则违反英文规范
为尚未存在的代码自动生成文档