mirror of
https://github.com/steipete/agent-rules.git
synced 2025-12-21 12:19:36 +01:00
b14f443855
Added comprehensive rules adapted from vincenthopf/claude-code: Development Workflows: - commit.mdc, commit-fast.mdc: Git commit workflows - add-to-changelog.mdc: Structured changelog updates - pr-review.mdc: Multi-role PR review checklist Code Quality: - check.mdc: Multi-language code quality checks - clean.mdc: Auto-fix formatting and linting - code-analysis.mdc: Advanced analysis options Problem Solving: - analyze-issue.mdc: GitHub issue analysis - bug-fix.mdc: Complete bug-fixing workflow - implement-task.mdc: Methodical implementation - five.mdc: Five Whys root cause analysis Documentation: - create-docs.mdc: Comprehensive doc generation - mermaid.mdc: Diagram generation Project Setup: - context-prime.mdc: Load project context - create-command.mdc: Create custom commands Credit: @vincenthopf (https://github.com/vincenthopf/claude-code) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
61 lines
1.4 KiB
Plaintext
61 lines
1.4 KiB
Plaintext
# Create Docs
|
|
|
|
Create comprehensive documentation for specified components or features.
|
|
|
|
## Analysis Areas:
|
|
1. Code structure and purpose
|
|
2. Inputs, outputs, and behavior
|
|
3. User interaction flows
|
|
4. Edge cases and error handling
|
|
5. Integration points with other components/systems
|
|
|
|
## Documentation Template:
|
|
|
|
### Overview
|
|
Brief 1-2 paragraph overview explaining purpose and value
|
|
|
|
### Usage
|
|
How to use this component/feature with examples
|
|
|
|
### API / Props / Parameters
|
|
Detailed specification of interfaces
|
|
|
|
### Component Hierarchy
|
|
Structure and relationships (if applicable)
|
|
|
|
### State Management
|
|
How state is handled and flows through the system
|
|
|
|
### Behavior
|
|
Expected behavior in different scenarios
|
|
|
|
### Error Handling
|
|
How errors are caught, handled, and reported
|
|
|
|
### Performance Considerations
|
|
Optimization notes and performance characteristics
|
|
|
|
### Accessibility
|
|
Accessibility features and compliance
|
|
|
|
### Testing
|
|
How to test this component/feature
|
|
|
|
### Related Components/Features
|
|
Links to related documentation
|
|
|
|
## Process:
|
|
1. Analyze the target code thoroughly
|
|
2. Identify all public interfaces
|
|
3. Document expected behaviors
|
|
4. Include code examples
|
|
5. Add diagrams where helpful
|
|
6. Follow project documentation standards
|
|
7. Ensure clarity, completeness, and actionability
|
|
|
|
## Output Formats:
|
|
- Markdown for general documentation
|
|
- JSDoc/TSDoc for code comments
|
|
- API documentation format
|
|
- README files
|
|
- Architecture decision records (ADRs) |