skills.rest
itou-daiki
itou-daikiCOMMUNITY
Explore all skills by this author →
GitHub

doc-updater

Generate codemaps and update READMEs from TypeScript AST and dependency analysis.

Updated Nov 17, 2025
Search Tags:#automation#typescript#documentation#dependencies#ast#codemaps
One-click install
npx skills add https://github.com/itou-daiki/easy_stat_edu --skill doc-updater-itou-daiki
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-updater
Source: https://github.com/itou-daiki/easy_stat_edu/tree/main/.agent/skills/doc-updater
Command: npx skills add https://github.com/itou-daiki/easy_stat_edu --skill doc-updater-itou-daiki

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires ts-morph, madge, jsdoc-to-markdown, tsx.

What problem does it solve?

Documentation and codemaps often lag behind code changes, causing onboarding friction and confusion. This skill automates updating architectural maps and READMEs to reflect the current codebase.

Core Features & Use Cases

  • Codemap Generation: Create architectural maps from the repository structure to visualize modules and dependencies.
  • Documentation Refresh: Automatically update READMEs and guides from code changes to maintain accurate documentation.
  • AST & Dependency Analysis: Leverage TypeScript AST and dependency graphs to map exports/imports and ensure docs reflect reality.
  • Use Case: When a refactor updates multiple packages, run codemap/doc-update to refresh all docs in one step.

Quick Start

Run the codemap and documentation updater to synchronize docs with the latest codebase.

Frequently Asked Questions about doc-updater

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically update READMEs and documentation when my TypeScript code changes?▼

This skill automates documentation updates by analyzing TypeScript AST and extracting JSDoc comments to refresh READMEs. It ensures your guides remain accurate and traceable without manual editing after refactoring.

How does dependency mapping work for generating architectural codemaps?▼

Dependency mapping works by using madge to analyze module exports and imports, creating a visual architectural map. This demonstrates the module structure and ensures documentation accurately reflects the codebase's dependency graph.

Can I use ts-morph to extract and update architectural maps across diverse codebases?▼

Yes, this skill uses ts-morph to perform TypeScript AST analysis across diverse codebases. It extracts module structures and dependency graphs to automatically generate and update architectural codemaps.

What is the best way to keep codemaps synchronized with codebase refactors?▼

The best way to keep codemaps synchronized is to run an automated pipeline that maps exports and imports, then updates documentation. This skill combines AST analysis and dependency mapping to refresh all docs in one step after a refactor.

Does this documentation updater work with TypeScript projects using JSDoc and tsx?▼

Yes, this skill is built for TypeScript projects and uses jsdoc-to-markdown for documentation extraction and tsx for execution. It integrates these dependencies to maintain alignment between code and documentation.

Related Skills

Explore More Software Engineering Skills→
BamoseBamose
5

doc-updater

Analyze TypeScript code with ts-morph and madge to regenerate codemaps and documentation.

Community
Advanced
johnqtcgjohnqtcg
29

update-doc

Align repository documentation with code evidence using minimal patches.

Community
Intermediate
flybirdxxflybirdxx

lint-and-validate

Run linters, type checkers, and security scanners on Node.js, Python, and TypeScript codebases.

Community
Advanced
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced