readme-architect
Installation
SKILL.md
Auto-Documentation & README Architect
This skill scans your project structure and code to create a comprehensive, professional README.md and documentation suite.
When to Use This Skill
- Initializing a new GitHub repository.
- Updating documentation for an existing project.
- Creating developer guides for internal tools.
- Generating API documentation from source code.
Instructions
- List the files and directories in the project.
- Read core files (e.g.,
package.json,requirements.txt, main entry points). - Identify the project's purpose, features, and tech stack.
- Generate a
README.mdwith: Title, Description, Features, Installation, Usage, and License. - Create a
CONTRIBUTING.mdif needed.