diff options
| author | TheSiahxyz <164138827+TheSiahxyz@users.noreply.github.com> | 2026-01-16 08:30:14 +0900 |
|---|---|---|
| committer | TheSiahxyz <164138827+TheSiahxyz@users.noreply.github.com> | 2026-01-16 08:30:14 +0900 |
| commit | 3fbb9a18372f2b6a675dd6c039ba52be76f3eeb4 (patch) | |
| tree | aa694a36cdd323a7853672ee7a2ba60409ac3b06 /default/.claude/commands/documentation/create-readme-section.md | |
updates
Diffstat (limited to 'default/.claude/commands/documentation/create-readme-section.md')
| -rw-r--r-- | default/.claude/commands/documentation/create-readme-section.md | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/default/.claude/commands/documentation/create-readme-section.md b/default/.claude/commands/documentation/create-readme-section.md new file mode 100644 index 0000000..5edb1ea --- /dev/null +++ b/default/.claude/commands/documentation/create-readme-section.md @@ -0,0 +1,73 @@ +# Create README Section + +Generate a specific section for a README file based on the user's request. This command helps create well-structured, professional README sections that follow best practices. + +## Usage Examples + +### Basic Usage +"Create an installation section for my Python project" +"Generate a contributing guide section" +"Write an API reference section for my REST endpoints" + +### Specific Sections +- **Installation**: Step-by-step setup instructions +- **Usage**: How to use the project with examples +- **API Reference**: Detailed API documentation +- **Contributing**: Guidelines for contributors +- **License**: License information +- **Configuration**: Configuration options and environment variables +- **Troubleshooting**: Common issues and solutions +- **Dependencies**: Required dependencies and versions +- **Architecture**: High-level architecture overview +- **Testing**: How to run tests +- **Deployment**: Deployment instructions +- **Changelog**: Version history and changes + +## Instructions for Claude + +When creating a README section: + +1. **Analyze the Project Context**: Look at existing files (package.json, requirements.txt, etc.) to understand the project +2. **Follow Markdown Best Practices**: Use proper headings, code blocks, and formatting +3. **Include Practical Examples**: Add code snippets and command examples where relevant +4. **Be Comprehensive but Concise**: Cover all important points without being verbose +5. **Match Existing Style**: If a README already exists, match its tone and formatting style + +### Section Templates + +#### Installation Section +- Prerequisites +- Step-by-step installation +- Verification steps +- Common installation issues + +#### Usage Section +- Basic usage examples +- Advanced usage scenarios +- Command-line options (if applicable) +- Code examples with expected output + +#### API Reference Section +- Endpoint descriptions +- Request/response formats +- Authentication details +- Error codes and handling +- Rate limiting information + +#### Contributing Section +- Development setup +- Code style guidelines +- Pull request process +- Issue reporting guidelines +- Code of conduct reference + +### Output Format + +Generate the section with: +- Appropriate heading level (usually ## or ###) +- Clear, structured content +- Code blocks with language specification +- Links to relevant resources +- Bullet points or numbered lists where appropriate + +Remember to ask for clarification if the section type or project details are unclear.
\ No newline at end of file |
