Wheels Documentation Generator

Generate documentation by extracting function signatures, parameters, and return values from your Wheels codebase, then render them into JSDoc-style CFML comments, Markdown README files, and API documentation. This automates consistent documentation across authentication, models, associations, validations, and deployment steps.

A documented Wheels function includes JSDoc-style comments with `@param` tags for each parameter and `@return` tags describing the output. For example, an authenticate function documents email and password parameters plus the User object or false return value, making code intent clear for team members.

Yes. This Skill captures model associations, validations, and overall purpose, then renders them into standardized documentation. It guides documenting relationships between models and validation rules, ensuring your data layer is transparent to developers maintaining the codebase.

Yes. The Skill generates a standard README.md template with sections for project description, requirements, installation, configuration, and testing. This provides new team members and collaborators with onboarding documentation covering setup and key workflows.

Documentation covers function-level docs with parameter and return types, model schemas including associations and validations, and project-wide README files. This applies across authentication systems, data models, business logic, and deployment procedures.

Consistent documentation using JSDoc-style comments and standardized READMEs reduces onboarding time, improves code maintainability, and prevents knowledge silos. Teams understand function purposes, parameter requirements, and project structure without reverse-engineering the codebase.