blob: 5edb1eaa970931534c21dc14731e9e7dbf09e1ab (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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.
|
