Auto-Documentation
Generates and maintains standardized documentation for public APIs, functions, and modules across multiple programming languages.
This skill automates the process of creating and updating documentation for your codebase, ensuring that public interfaces, classes, and modules remain well-documented as the project evolves. It intelligently detects changes in function signatures or new exports to trigger JSDoc or Python docstring updates, focusing on explaining intent and non-obvious constraints rather than just restating the code. By providing standardized examples and enforcing consistent styles, it significantly reduces onboarding friction and improves code maintainability for development teams.
主な機能
01Standardized JSDoc and Python docstring generation with parameters, return types, and exceptions
02Automatic detection of new public exports and modified function signatures
03Style enforcement to ensure consistent documentation across the entire project
04Automated inclusion of usage examples for complex API endpoints
05Context-aware documentation focusing on the 'why' and architectural constraints
06438 GitHub stars
ユースケース
01Improving developer onboarding by documenting the intent and edge cases of new modules
02Maintaining consistent documentation standards across large TypeScript or Python monorepos
03Updating API documentation automatically during major refactoring of function parameters