README Generator

This skill automatically analyzes Spring Boot modules and generates comprehensive README.md files according to the specified format requirements, including module functionality, API documentation, usage examples, technical implementation, testing guidance, and important notes.

When to Use

Use this skill when you need to:

• Generate README.md files for new modules
• Update existing README.md files when module content changes
• Create consistent documentation across multiple modules
• Document API interfaces automatically
• Provide comprehensive module documentation for developers

How to Use

Generate README for a Module

Execute the README generator script to create comprehensive documentation: