a224aced85
- Reorganize cursor rules into logical domain-based directories - Implement meta-rule system for workflow-specific rule bundling - Move core rules to dedicated /core directory - Consolidate development rules under /development namespace - Add architectural patterns and implementation examples - Create workflow-specific meta-rules for common development tasks - Remove deprecated standalone rule files - Update package dependencies for new rule structure BREAKING CHANGE: Cursor rules file structure has been reorganized Files moved from root rules directory to domain-specific subdirectories
38 lines
1.6 KiB
Plaintext
38 lines
1.6 KiB
Plaintext
---
|
|
alwaysApply: false
|
|
---
|
|
# Directive for Documentation Generation
|
|
|
|
1. Produce a **small, focused set of documents** rather than an overwhelming volume.
|
|
2. Ensure the content is **maintainable and worth preserving**, so that humans
|
|
are motivated to keep it up to date.
|
|
3. Prioritize **educational value**: the documents must clearly explain the
|
|
workings of the system.
|
|
4. Avoid **shallow, generic, or filler explanations** often found in AI-generated
|
|
documentation.
|
|
5. Aim for **clarity, depth, and usefulness**, so readers gain genuine understanding.
|
|
6. Always check the local system date to determine current date.
|
|
|
|
## Model Implementation Checklist
|
|
|
|
### Before Documentation Creation
|
|
|
|
- [ ] **Scope Definition**: Define what needs to be documented
|
|
- [ ] **Audience Analysis**: Identify target readers and their needs
|
|
- [ ] **Content Planning**: Plan focused, educational content structure
|
|
- [ ] **Maintenance Planning**: Ensure content will be worth preserving
|
|
|
|
### During Documentation Creation
|
|
|
|
- [ ] **Educational Focus**: Clearly explain how the system works
|
|
- [ ] **Depth and Clarity**: Provide genuine understanding, not surface explanations
|
|
- [ ] **Focused Content**: Keep documents small and focused on specific topics
|
|
- [ ] **Current Date**: Check local system date for time-sensitive content
|
|
|
|
### After Documentation Creation
|
|
|
|
- [ ] **Quality Review**: Ensure content is clear, deep, and useful
|
|
- [ ] **Maintainability Check**: Verify content motivates humans to keep it updated
|
|
- [ ] **Audience Validation**: Confirm content meets target reader needs
|
|
- [ ] **Integration**: Integrate with existing documentation structure
|