domains / families / software-engineering / code-documenter

code-documenter

separate

Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.

When to use

• Adding docstrings to functions, classes, and modules
• Writing OpenAPI/Swagger specs or JSDoc annotations
• Creating API documentation for REST or GraphQL endpoints
• Building documentation sites or developer portals
• Writing getting-started guides, tutorials, and user guides

When not to use

• Documenting obvious getters/setters verbosely
• Creating documentation that is hard to maintain

Skill page

Source