mcpField
N
ns-docs-writer

ns-docs-writer

github.com/nextstage-brasil文档处理0127 次安装5 天前更新
代码仓库

关于 ns-docs-writer

ns-docs-writer 是用于编写和维护 docs/ 与 README 文档的技能，适合项目开发者、操作者及终端用户文档工作。它按发现、确定受众、拟纲、起草和链接的流程开展，并与代码注释及 living spec 区分范围。

主要功能

  1. 01编写 README 和 docs 文档
  2. 02检查现有文档与适用范围
  3. 03确定受众并规划提纲
  4. 04按风格指南起草内容
  5. 05链接到规范文档

适用场景

  1. 01为已交付功能编写文档
  2. 02结构变更后更新 README
  3. 03编写贡献者入门指南
  4. 04将分散笔记整理到 docs/

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/ns-docs-writer确认已加载。

附带文件evals/evals.jsonreferences/style-guide.md

详细介绍

文档编写

在 docs/ 和 README 文件中编写清晰、易维护的项目文档。

会话启动

参见 ../../ns-harness/references/session-boot.md。

范围

范围内范围外
产品或仓库根目录下的 README.md行内 // 或 /** 代码注释
docs/**/*.md 指南docs/versions/*/sdd/requirements.md、docs/versions/*/requirements.md（旧版 SDD）
面向人员的操作手册、安装指南、架构概览docs/specs/ 中的持续维护规范（使用 ns-living-spec）
按需编写的变更日志条目仓库外的营销文案

适用场景

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

工作流

  1. 发现 — 列出现有的 docs/、README 和 AGENTS.md 链接；避免重复记录 harness/brownfield 产物（改用链接）。
  2. 受众 — 确认受众是开发者、运维人员还是终端用户（默认：开发者）。
  3. 提纲 — 编写长篇指南前先列出简短目录。
  4. 起草 — 遵循 references/style-guide.md。
  5. 链接 — 优先使用相对链接；相关时指向 .nextstage-harness/rules/ 中的权威规则。

目录结构（与技术栈无关）

不要假设仓库采用 monorepo 的 packages/ 结构。根据以下内容判断：

  • AGENTS.md 中的目录结构表
  • architecture-rules.md
  • 现有的 docs/ 结构

仅当子目录符合项目惯例时才创建。

集成

由 ns-spec-driven 调用时，记录已交付的行为——不要臆造需求。

Agent 的缘由（参考架构、Agent 与代码、权衡、拓扑、HITL、变更信号）位于 docs/specs/agent-architecture.md。请链接到该文档。不要在 README 中复制访谈内容或重写决策记录。docs/specs/agent.md 描述的是行为（ns-living-spec），不是这份 ADR。

禁止事项

  • 将 brownfield-map.md 或 system-reverse-spec.md 的完整内容复制到新文档中（请链接到它们）
  • 项目要求使用英文文档时违反英文要求
  • 为尚不存在的代码自动生成文档
  • 同一版本同时存在 docs/versions/*/sdd/requirements.md 和旧版 docs/versions/*/requirements.md ——仅链接到权威的 sdd/ 路径；绝不创建或维护两套目录结构

评论

支持 Markdown