skills.rest
devopstales
devopstalesCOMMUNITY
Explore all skills by this author →
Website𝕏@_devopstalesGitHub

doc-updater

Generates and updates codemaps and documentation from source code using TypeScript CLI tools.

1|Updated Apr 22, 2026
Search Tags:#code analysis#documentation#software development#TypeScript#codemap
One-click install
npx skills add https://github.com/devopstales/aiskillgrid --skill doc-updater-devopstales
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-updater
Source: https://github.com/devopstales/aiskillgrid/tree/main/.agents/skills_back/doc-updater
Command: npx skills add https://github.com/devopstales/aiskillgrid --skill doc-updater-devopstales

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires typescript, tsx, madge, jsdoc2md, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill simplifies the process of updating codemaps and documentation, ensuring they remain accurate and synchronized with the codebase.

Core Features & Use Cases

  • Automated Codemap Generation: Automatically creates architectural maps from the codebase structure.
  • Documentation Updates: Refreshes READMEs and guides from code.
  • AST Analysis: Utilizes TypeScript compiler API for in-depth code analysis.
  • Dependency Mapping: Tracks imports/exports across modules.
  • Documentation Quality: Ensures documentation matches the current codebase reality.
  • Use Case: For a software development team, this Skill ensures that the project documentation is always in sync with the latest code changes, avoiding confusion and saving time.

Quick Start

Run 'npx tsx scripts/codemaps/generate.ts' to generate codemaps for your repository.

Frequently Asked Questions about doc-updater

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

FAQPage Schema
How do I automatically generate and update codemaps from TypeScript source code?▼

You can generate and update codemaps from TypeScript source code by running 'npx tsx scripts/codemaps/generate.ts'. This Skill uses the TypeScript compiler API to analyze your codebase structure and automatically create architectural maps.

What is the best way to keep project documentation synchronized with code changes?▼

Keeping project documentation synchronized with code changes is handled by this Skill through automated documentation updates. It refreshes READMEs and guides directly from your source code, ensuring documentation matches the current codebase reality.

Do I need madge and jsdoc2md to track imports and exports across modules?▼

Yes, you need madge and jsdoc2md CLI tools to track imports and exports across modules. This Skill requires these specific dependencies alongside TypeScript and tsx to perform dependency mapping and documentation generation.

Can I use this automated documentation generation tool for non-TypeScript projects?▼

Using this automated documentation generation tool for non-TypeScript projects is not supported, as it requires the TypeScript compiler API for AST analysis. It is specifically designed to analyze TypeScript codebases and track module dependencies.

How does AST analysis work for updating software documentation?▼

AST analysis for updating software documentation works by utilizing the TypeScript compiler API for in-depth code analysis. It parses the abstract syntax tree to extract structural information, automatically refreshing your guides and READMEs from the code.

Related Skills

Explore More Software Engineering Skills→
jikimejikime
5

jikime-workflow-codemap

Generate codebase architecture documentation via AST analysis and dependency visualization.

Community
Advanced
j7-devj7-dev
19

doc-updater

Generate and update codemaps and README files to reflect current codebase status.

Community
Intermediate
barikata1984barikata1984

quality-review

Automates git-based code quality reviews for commits and pull requests.

Community
Intermediate
windyskywindysky

moai-docs-generation

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

Community
Advanced