关于 ns-code-docs-writer
ns-code-docs-writer 是面向开发者的技能，用于编写和维护 README 文件及 docs/ 中的项目文档。它会先检查现有指引与文档结构，再按受众规划和起草内容。
主要功能
- 01README 与 docs/ 文档撰写
- 02检查现有文档与项目指引
- 03按受众规划和起草文档
- 04使用相对链接连接规范
适用场景
- 01为新功能编写用户或开发者文档
- 02结构调整后更新过时的 README
- 03整理贡献者入门指南
- 04将分散笔记整合到 docs/
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/ns-code-docs-writer确认已加载。
附带文件evals/evals.jsonreferences/style-guide.md
详细介绍
文档编写器
在 docs/ 和 README 文件中编写清晰、易维护的项目文档。
Harness 发现
参见 ../ns-harness/references/harness-discovery.md。从 AGENTS.md 中解析 {product_root}。
范围
| 范围内 | 范围外 |
|---|---|
产品或仓库根目录下的 README.md | 行内 // 或 /** 代码注释 |
docs/**/*.md 指南 | docs/versions/*/requirements.md |
| 面向开发者的操作手册、安装指南、架构概览 | docs/specs/ 中持续维护的规格（使用 ns-sdd-living-spec-consolidator） |
| 按需编写的变更日志条目 | 仓库外的营销文案 |
适用场景
- 新功能需要用户或开发者文档
- 结构变更后 README 内容过时
- 为贡献者编写入门指南
- 将零散笔记汇总到
docs/
工作流程
- 发现 — 列出已有的
docs/、README 和AGENTS.md链接；避免重复编写 Harness 或棕地项目资料（改为链接）。 - 受众 — 确认受众是开发者、运维人员还是终端用户（默认：开发者）。
- 大纲 — 撰写较长指南前，先列出简短目录。
- 起草 — 遵循
references/style-guide.md。 - 链接 — 优先使用相对链接；在相关时链接到
.nextstage-harness/rules/中的规范规则。
布局（与技术栈无关）
不要假定采用单体仓库的 packages/ 布局。根据以下内容判断：
AGENTS.md布局表architecture-rules.md- 现有的
docs/结构
仅在符合项目惯例时创建子文件夹。
集成
由 ns-spec-driven 调用时，应记录已交付的行为，不要臆造需求。
禁止事项
- 将
brownfield-map.md或system-reverse-spec.md的完整内容复制到新文档中（应链接到这些文件） - 项目要求使用英文文档时违反该要求
- 为尚不存在的代码自动生成文档
评论
支持 Markdown