doc-updater_skill

This skill proactively updates codemaps and documentation from code, ensuring READMEs, guides, and architecture maps stay accurate.

JavaScript

0

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill itou-daiki/easy_stat_edu --skill doc-updater

SKILL.md10.8 KB

Overview

This skill is a Documentation and Codemap Specialist that proactively updates codemaps and documentation to match the codebase. It runs automated tasks to generate docs/CODEMAPS/*, refresh READMEs and guides, and extract API docs from source code. Use it to keep architecture maps, README, and guides accurate and verifiable.

How this skill works

The skill analyzes the repository using TypeScript AST tools (ts-morph / TypeScript Compiler API) and dependency graph tools (madge) to discover entry points, exports, imports, routes, and models. It generates codemap markdown under docs/CODEMAPS/, extracts JSDoc/TSDoc into API references, and updates README and guides using scripts like scripts/codemaps/generate.ts and scripts/docs/update.ts. It validates file existence, links, and examples as part of the update workflow.

When to use it

After adding or changing API routes or public exports
Before major releases or feature merges
When onboarding new contributors or documenting architecture
Weekly maintenance to detect drift between code and docs
When adding or removing external integrations or DB schemas

Best practices

Generate codemaps from source — avoid manual-only updates
Include a freshness timestamp on each codemap and README
Keep codemaps concise (aim under 500 lines per area) and cross-reference related maps
Validate links and runnable examples during each update
Run the update scripts as part of CI or before merging major features

Example use cases

Regenerate frontend and backend codemaps after a large refactor to reflect new entry points and routes
Extract API reference from JSDoc/TSDoc to populate docs/GUIDES/api.md automatically
Update README setup steps and .env variable list when new environment keys are introduced
Produce an integrations codemap listing external services, their purpose, and versions for release notes
Run weekly check to find new source files not represented in codemaps and open a docs PR

FAQ

It generates docs/CODEMAPS/* (INDEX.md, frontend.md, backend.md, database.md, integrations.md, workers.md), updates README.md and docs/GUIDES/*.md, and produces API reference from JSDoc/TSDoc.

How does it ensure documentation matches code?

It uses AST analysis and dependency graphs to extract exports, imports, routes, and models, validates file paths and links, checks that code examples compile, and stamps codemaps with last-updated dates.