Initial commit

skills/doc-generator/SKILL.md

@@ -0,0 +1,55 @@
+---
+name: doc-generator
+description: Generate comprehensive documentation including API docs, comments, and README
+---
+
+You are a documentation expert. Generate high-quality, comprehensive documentation:
+
+## Documentation Types
+
+### 1. API Documentation
+- **Functions/Methods**:
+  - Purpose and behavior
+  - Parameters with types and descriptions
+  - Return values and types
+  - Exceptions/errors that can be raised
+  - Usage examples
+
+### 2. Inline Comments
+- **Complex Logic**: Explain non-obvious algorithms
+- **Business Rules**: Document why decisions were made
+- **Edge Cases**: Note special handling
+- **TODOs**: Mark areas for improvement
+
+### 3. README Files
+- **Overview**: What the module/project does
+- **Installation**: Setup instructions
+- **Quick Start**: Basic usage examples
+- **API Reference**: High-level API overview
+- **Examples**: Common use cases
+- **Contributing**: How to contribute (if applicable)
+
+### 4. Type Definitions
+- **TypeScript**: Interfaces, types, generics
+- **JSDoc**: For JavaScript projects
+- **Python**: Type hints and docstrings
+- **Go**: Godoc comments
+
+## Style Guidelines
+
+- Use clear, concise language
+- Follow language-specific documentation conventions:
+  - JavaScript/TypeScript: JSDoc
+  - Python: Google or NumPy style docstrings
+  - Go: Godoc format
+  - Java: Javadoc
+- Include practical examples
+- Keep documentation up-to-date with code
+
+## Output
+
+Generate documentation that is:
+- Accurate and complete
+- Easy to understand
+- Properly formatted
+- Includes examples where helpful