DocumentAPI

Name: DocumentAPI
Availability: InStock
Author: fnoritomi

Enumerate public API surfaces and freeze contracts for TypeScript/JavaScript projects.

Updated Aug 23, 2026

Search Tags:#static analysis #TypeScript #API documentation #analyze #exports #re-exports #contract stability

Ready to run

npx skills add https://github.com/fnoritomi/tabulador-dados-abertos --skill documentapi

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: DocumentAPI
Source: https://github.com/fnoritomi/tabulador-dados-abertos/tree/main/.agent/skills/document-api
Command: npx skills add https://github.com/fnoritomi/tabulador-dados-abertos --skill documentapi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill analyzes modules to enumerate their public API surface and freeze contracts before refactoring.

Core Features & Use Cases

Public API discovery: Identify exported functions, classes, interfaces, types, and constants across a codebase.
Re-exports & Dependencies: Track re-exports and inter-module dependencies to map API boundaries.
Documentation Output: Generate a structured Markdown document that lists each export with its source and signature.

Quick Start

Analyze a TypeScript/JavaScript project directory to generate a PUBLIC_API.md documenting all module exports.

Frequently Asked Questions about DocumentAPI

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

FAQPage Schema

How do I discover and document the public API surface of a TypeScript project?▼

To discover and document the public API surface of a TypeScript project, analyze the codebase to extract exports, categorize functions and interfaces, and generate a structured Markdown document listing module signatures.

What is the best way to track re-exports and module dependencies before refactoring?▼

Tracking re-exports and module dependencies before refactoring involves auditing inter-module boundaries to map API stability. This process extracts and categorizes exports to ensure contract stability across large codebases.

Can I freeze API contracts and generate documentation for JavaScript codebases?▼

Yes, you can freeze API contracts and generate documentation for JavaScript codebases. The analysis targets TypeScript and JavaScript projects to audit exports, track dependencies, and output structured Markdown docs.

How do I map API boundaries and inter-module dependencies in a large codebase?▼

Mapping API boundaries and inter-module dependencies in a large codebase requires auditing re-exports and tracking dependencies. This extracts public API surfaces to freeze contracts before refactoring.

Does static analysis of TypeScript exports support Markdown documentation output?▼

Static analysis of TypeScript exports supports Markdown documentation output by extracting functions, classes, and types. It generates a structured PUBLIC_API.md document listing each export with its source and signature.