mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
refactor: Standardize @include reference system across all command files
- Fix @include references to use underscore format (Universal_Legend, Standard_Messages_Templates) - Add missing ultracompressed.yml shared pattern file - Update broken reference paths in all 18 command files - Ensure consistent template naming across command system - Optimize command file structure with standardized includes 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -1,107 +1,36 @@
|
||||
# /document - Generate comprehensive documentation
|
||||
|
||||
## Legend
|
||||
@include shared/universal-constants.yml#Universal_Legend
|
||||
|
||||
## Purpose
|
||||
Generate comprehensive documentation for code, APIs, or systems specified in $ARGUMENTS with various output formats and styles.
|
||||
## Command Execution
|
||||
Execute: immediate. --plan→show plan first
|
||||
Legend: Generated based on symbols used in command
|
||||
Purpose: "[Action][Subject] in $ARGUMENTS"
|
||||
|
||||
## Syntax
|
||||
`/document [flags] [target]`
|
||||
Generate comprehensive documentation for code, APIs, or systems specified in $ARGUMENTS.
|
||||
|
||||
@include shared/flag-inheritance.yml#Universal_Always
|
||||
|
||||
## Core Flags
|
||||
Examples:
|
||||
- `/document --type api --format openapi` - Generate API documentation
|
||||
- `/document --type readme --style detailed` - Create comprehensive README
|
||||
- `/document --type user --style tutorial` - User guide w/ tutorials
|
||||
|
||||
--type flag:
|
||||
- api: API documentation (OpenAPI/Swagger)
|
||||
- code: Code documentation (JSDoc/docstrings)
|
||||
- readme: Project README files
|
||||
- architecture: System architecture docs
|
||||
- user: End-user documentation
|
||||
- dev: Developer guides
|
||||
Documentation modes:
|
||||
|
||||
--format flag:
|
||||
- markdown: Markdown format (default)
|
||||
- html: HTML documentation
|
||||
- pdf: PDF output
|
||||
- docusaurus: Docusaurus compatible
|
||||
- mkdocs: MkDocs compatible
|
||||
**--type:** Documentation type
|
||||
- api: API documentation (OpenAPI/Swagger) | code: Code documentation (JSDoc/docstrings)
|
||||
- readme: Project README files | architecture: System architecture docs
|
||||
- user: End-user documentation | dev: Developer guides
|
||||
|
||||
--style flag:
|
||||
- concise: Brief, essential information only
|
||||
- detailed: Comprehensive with examples
|
||||
- tutorial: Step-by-step guide format
|
||||
- reference: API reference style
|
||||
**--format:** Output format
|
||||
- markdown: Markdown format (default) | html: HTML documentation
|
||||
- pdf: PDF output | docusaurus: Docusaurus compatible | mkdocs: MkDocs compatible
|
||||
|
||||
## Documentation Types
|
||||
**--style:** Documentation style
|
||||
- concise: Brief, essential information only | detailed: Comprehensive with examples
|
||||
- tutorial: Step-by-step guide format | reference: API reference style
|
||||
|
||||
API Documentation:
|
||||
- OpenAPI 3.0 specification
|
||||
- Request/response examples
|
||||
- Authentication details
|
||||
- Error codes & handling
|
||||
- Rate limiting information
|
||||
@include shared/docs-patterns.yml#Project_Documentation
|
||||
|
||||
Code Documentation:
|
||||
- Function/method descriptions
|
||||
- Parameter & return types
|
||||
- Usage examples
|
||||
- Edge cases & limitations
|
||||
- Related functions
|
||||
@include shared/docs-patterns.yml#Standard_Notifications
|
||||
|
||||
Architecture Documentation:
|
||||
- System overview diagrams
|
||||
- Component interactions
|
||||
- Data flow documentation
|
||||
- Technology decisions
|
||||
- Scalability considerations
|
||||
|
||||
User Documentation:
|
||||
- Getting started guides
|
||||
- Feature explanations
|
||||
- Common use cases
|
||||
- Troubleshooting guides
|
||||
- FAQ sections
|
||||
|
||||
## Best Practices
|
||||
|
||||
Structure:
|
||||
- Clear hierarchy & navigation
|
||||
- Consistent formatting
|
||||
- Search-friendly content
|
||||
- Version-specific docs
|
||||
- Cross-references
|
||||
|
||||
Content:
|
||||
- Examples for everything
|
||||
- Progressive disclosure
|
||||
- Visual aids when helpful
|
||||
- Keep updated with code
|
||||
- Test documentation
|
||||
|
||||
@include shared/docs-patterns.yml#Documentation_Standards
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Generate API documentation
|
||||
/document --type api --format openapi
|
||||
|
||||
# Create comprehensive README
|
||||
/document --type readme --style detailed
|
||||
|
||||
# Architecture documentation with diagrams
|
||||
/document --type architecture --think
|
||||
|
||||
# User guide with tutorials
|
||||
/document --type user --style tutorial
|
||||
```
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Documentation files in specified format
|
||||
- Table of contents & navigation
|
||||
- Code examples & snippets
|
||||
- Diagrams & visual aids
|
||||
- Search index if applicable
|
||||
@include shared/universal-constants.yml#Standard_Messages_Templates
|
||||
Reference in New Issue
Block a user