在代码改动完成后,快速整理并更新对应技术文档与说明内容。
复制安装指令,让 AI 自动完成配置 · 推荐新手
请帮我安装 askskill 上的 "updating-noridocs" 技能: 1. 下载 https://raw.githubusercontent.com/microsoft/FluidFramework/main/.agency/plugins/nori/skills/updating-noridocs/SKILL.md 2. 保存为 ~/.claude/skills/updating-noridocs/SKILL.md 3. 装好后重载技能,告诉我可以用了
我刚完成用户登录模块的代码调整:新增 refresh token 接口,修改了登录返回字段,并废弃旧的 session 校验方式。请根据这些变更更新 API 文档,包含接口说明、请求参数、返回示例、变更说明和弃用提示。
一份更新后的接口文档草稿,清楚反映新增、修改与废弃内容。
项目最近重构了本地启动流程:环境变量名称有变化,启动命令从 npm 改成 pnpm,并新增了 Docker 启动方式。请更新 README,重点修改安装、配置、启动和常见问题部分。
一份可直接提交的 README 更新内容,覆盖最新启动与配置方式。
以下是本次版本的代码变更:修复支付重试 bug、优化报表查询性能、新增管理员导出权限控制。请整理成面向内部团队和客户都能理解的发布说明,区分新功能、修复项和注意事项。
一份结构清晰的版本发布说明,适合内部同步或对外发布。
Noridocs are docs.md files throughout the codebase that document each folder's purpose, architecture, and implementation. Update them after code changes using the nori-change-documenter subagent.
Core principle: Provide context → Dispatch subagent → Verify updates.
Announce at start: "I'm using the Updating Noridocs skill to update documentation."
Prepare information for the subagent:
Use Task tool with nori-change-documenter type:
Task(subagent_type: nori-change-documenter)
In the prompt, provide:
Check that documentation was updated:
git status to see which docs.md files changedEach docs.md follows this structure:
# Noridoc: [Folder Name]
Path: [Path to the folder from the repository root. Always start with @. For
example, @/src/endpoints or @/docs ]
### Overview
[2-3 bullet summary of the folder]
### How it fits into the larger codebase
[2-10 bullet description of how the folder interacts with and fits into other
parts of the codebase. Focus on system invariants, architecture, internal
depenencies, places that call into this folder, and places that this folder
calls out to]
### Core Implementation
[2-10 bullet description of entry points, data paths, key architectural
details, state management]
### Things to Know
[2-10 bullet description of tricky implementation details, system invariants,
or likely error surfaces]
Created and maintained by Nori.
Noridocs should NOT list files, maintain counts, or track line numbers. These are brittle documentation patterns that will break very quickly.
Providing vague context
Skipping verification
Documenting trivial changes
Never:
Always:
用四阶段系统化排查框架定位缺陷根因,再制定可靠修复方案。
引导用户协作撰写文档、方案与技术规格,并通过迭代完善内容质量。