The api-docs skill automates the creation of professional developer documentation by intelligently analyzing TypeScript and JavaScript source files. It identifies public exports, parses existing JSDoc annotations, and automatically generates missing documentation to ensure 100% coverage across functions, classes, and interfaces. Beyond standard JSDoc, it can transform HTTP endpoint definitions into valid OpenAPI 3.0 specifications, helping development teams maintain synchronized, high-quality documentation for internal libraries and public-facing APIs without manual overhead.
주요 기능
01Enforcement of documentation standards including @param, @returns, and @example
02Deep scanning of public exports, classes, and interfaces
03Automated JSDoc extraction and AI-powered generation for missing docs
04Native integration with the Ruflo meta-harness via MCP hooks
05OpenAPI 3.0 specification generation for HTTP endpoints
0669,386 GitHub stars
사용 사례
01Documenting legacy JavaScript codebases with missing type information and comments
02Standardizing documentation across a distributed team using AI-driven conventions
03Automatically generating and updating OpenAPI specs for RESTful backend services