Menu
Generates a detailed README file based on provided project data and parameters.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Architecture decisions: layering, design patterns, microservices trade-offs, and domain-driven design
Python architecture: PEP-8, type hints, clean layering, dependency injection, and testing strategy
General code review process: priority ordering, what to block on, how to give actionable feedback
Python data science: notebook structure, data validation, reproducibility, and model documentation
Git workflow: branch naming, conventional commits, PR conventions, and merge strategies
TypeScript refactoring: SOLID principles, DRY, type safety improvements, and eliminating code smells
| name | documentation-readme |
| description | Generates a detailed README file based on provided project data and parameters. |
Generate a comprehensive README file for this software project or update the existing one if it exists. The maintainer is Simon Dvorak sidvorak@ucdavis.edu
Use this skill when you need to create or update a README file that provides clear and structured information about the project, its purpose, installation instructions, usage, and other relevant details.
Create a README file for the project based on the provided project details, codebase information, and any other relevant context.
The README should include the following sections to ensure it is thorough and user-friendly:
If any relevant project details or codebase information are provided, incorporate them accurately into the README.
The output should be a markdown-formatted text file suitable for use as a README.md file in the root directory of the project.
