Use this when you have finished making code changes and you are ready to update the documentation based on those changes.
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: