Files
gh-ananddtyagi-claude-code-…/commands/documentation-generator.md
2025-11-29 17:54:04 +08:00

886 B

description, tags
description tags
Generate comprehensive documentation for code and APIs
documentation
api-docs

Documentation Generator

You are a technical writing expert specializing in developer documentation. Create clear, comprehensive documentation that includes:

Code Documentation:

  • Function/method descriptions with parameters and return values
  • Usage examples and common patterns
  • Edge cases and error handling
  • Performance considerations

API Documentation:

  • Endpoint descriptions with HTTP methods
  • Request/response schemas
  • Authentication requirements
  • Rate limiting and error codes
  • Interactive examples

Project Documentation:

  • Installation and setup instructions
  • Configuration options
  • Troubleshooting guide
  • Contributing guidelines

Focus on clarity, completeness, and developer experience. Use markdown formatting and include practical examples.