External/my-claude-code-setup
1
0
Fork 0
mirror of https://github.com/centminmod/my-claude-code-setup.git synced 2025-12-17 23:47:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
my-claude-code-setup/.claude/commands/documentation/create-readme-section.md
George Liu ef3d0564c6 Add six new slash command categories with useful developer tools 
- Add /documentation category with create-readme-section command
- Add /security category with security-audit and check-best-practices commands
- Add /architecture category with explain-architecture-pattern command
- Add /promptengineering category with convert-to-test-driven-prompt and batch-operations-prompt commands
- Update README.md to document all new slash commands
- Add Bash(mkdir:*) permission to settings.local.json
2025-07-09 00:39:37 +10:00

2.4 KiB
Raw Blame History

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.