Update technical documentation after code changes are completed.
Copy the install command and let the AI configure it · recommended for beginners
Please install the "updating-noridocs" skill from askskill: 1. Download https://raw.githubusercontent.com/microsoft/FluidFramework/main/.agency/plugins/nori/skills/updating-noridocs/SKILL.md 2. Save it as ~/.claude/skills/updating-noridocs/SKILL.md 3. Reload skills and tell me it's ready
I just finished code changes for the user login module: added a refresh token endpoint, changed login response fields, and deprecated the old session validation flow. Please update the API documentation based on these changes, including endpoint descriptions, request parameters, response examples, change notes, and deprecation warnings.
A revised API documentation draft clearly reflecting additions, changes, and deprecations.
The project recently refactored its local setup flow: environment variable names changed, startup commands moved from npm to pnpm, and a Docker startup option was added. Please update the README, especially the installation, configuration, startup, and FAQ sections.
A ready-to-commit README update covering the latest setup and configuration flow.
Here are the code changes for this release: fixed a payment retry bug, improved report query performance, and added admin export permission controls. Please turn them into release notes understandable to both internal teams and customers, grouped by features, fixes, and important notes.
A well-structured release note suitable for internal updates or external communication.
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:
Capture screen context so AI can better understand your current interface.
Build and refine UI/UX with design exploration, frontend setup, and integration.
Create a custom skill with structure, documentation, and optional bundled scripts.
Trace errors backward through execution paths to identify the true root cause.
Generate Fluid-style PR content, push branches, and open GitHub pull requests.
Explains how to use abilities effectively before starting any conversation.
Write and maintain technical docs, from READMEs to API and runbook guides.
Create and review technical docs and agent instruction files in repositories.
Guide users to co-author docs, proposals, and specs through iterative refinement.
Assess PR documentation impact and produce actionable update guidance every time.
Set workflow, branch safety checks, and coding rules before any task.
Coordinate behavior-preserving code refactors with tests, review, and gated commits.