Documentarian

Introduction

After changes are made to the codebase, your job is to review the changes and systematically update related documentation.

Instructions

1. Review Latest Changes

Inspect the latest git commits and any unstaged changes. Make a list of files that were changed, including app routes, components, hooks, and utility functions.

This will serve as our checklist in Step 2.

2. Search Docs for Changed Files

Review existing documentation by searching the following locations for mentions of each changed file from Step 1:

•The .claude directory and all sub-folders. Treat Claude Skills and supporting files as documentation.
•The main README.md file.
•The CHANGELOG.md
•The docs directory. This will be mostly deprecated in the future, but for now it is still place where drafts are kept.

3. Update Existing Docs

Based on the results of your search in Step 2, update the related documentation files. Pay particular attention to the supporting files in each Claude Skill.

4. Create New Docs

If any features are not yet covered in the existing documentation, write the necessary docs, or add the new changes/features to existing docs.

5. Delegate to Specialized Skills

When changes involve specific domains, delegate documentation updates to the appropriate skill:

Change Type	Delegate To	Description
Transaction schemas	`/transaction-auditor`	API schema sync, TX_TYPE_MAP, tx-state-machine.md
API hooks/patterns	`/audit-api-coverage`	Hook patterns, transformers, query keys, API coverage - Use to refine hooks following best practices
Styling/components	`/design-system reference`	Component patterns, color system
Project status	`/project-manager`	STATUS.md, ROADMAP.md, feature tracking
Type system issues	`/typescript-types-expert audit`	Type imports, NullableString, generated types
Template sync	`/sync-template`	Sync changes from app to template repo via rebase workflow

6. Suggest New Claude Skills

Now that we are storing most documentation in Claude Skills, can you recommend any new Skills we should build to make this App Template more accessible to vibe coders?

Add any new skill suggestions to the BACKLOG.md file in this skill directory. This file tracks:

•Suggested new skills (with priority and rationale)
•Documentation improvement ideas
•Process improvements for the documentarian skill itself

Review the backlog periodically and move completed items to the archive section.

Key Documentation Files

Hooks (API Connection Layer)

Important: Hooks are the ONLY interface between UX components/pages and the API.

File	Purpose
`src/hooks/api/`	All API hooks (course, project, etc.)
`src/hooks/tx/`	Transaction hooks
`.claude/skills/audit-api-coverage/api-hooks-audit.md`	API hook patterns and checklist
`.claude/skills/audit-api-coverage/tx-hooks-audit.md`	TX hook patterns and checklist

When reviewing hook changes, use /audit-api-coverage api-hooks to verify patterns.

Transaction-Related

File	Purpose
`src/config/transaction-schemas.ts`	Zod validation schemas
`src/config/transaction-ui.ts`	TX types, endpoints, UI strings
`src/hooks/tx/use-tx-watcher.ts`	TX_TYPE_MAP, status polling
`.claude/skills/audit-api-coverage/tx-state-machine.md`	TX State Machine docs
`.claude/skills/project-manager/TX-MIGRATION-GUIDE.md`	Migration patterns

Type Generation

File	Purpose
`src/types/generated/gateway.ts`	Auto-generated from API spec
`src/types/generated/index.ts`	Clean type exports

When API types change, run npm run generate:types to regenerate.

Examples

Claude Code will build these examples, and they will be refined with each iteration.

Output Format

•Simple report of all changes and recommendations in Claude REPL