lmiranda
2d51df7a42
Phase 1b: Rename all ~94 commands across 12 plugins to /<noun> <action> sub-command pattern. Git-flow consolidated from 8→5 commands (commit variants absorbed into --push/--merge/--sync flags). Dispatch files, name: frontmatter, and cross-reference updates for all plugins. Phase 2: Design documents for 8 new plugins in docs/designs/. Phase 3: Scaffold 8 new plugins — saas-api-platform, saas-db-migrate, saas-react-platform, saas-test-pilot, data-seed, ops-release-manager, ops-deploy-pipeline, debug-mcp. Each with plugin.json, commands, agents, skills, README, and claude-md-integration. Marketplace grows from 12→20. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
68 lines
1.2 KiB
Markdown
68 lines
1.2 KiB
Markdown
---
|
|
name: doc-patterns
|
|
description: Common documentation structures and patterns
|
|
---
|
|
|
|
# Documentation Patterns
|
|
|
|
## Purpose
|
|
|
|
Defines common documentation file structures and their contents.
|
|
|
|
## When to Use
|
|
|
|
- **doc audit**: Understanding what to check in each doc type
|
|
- **doc coverage**: Identifying documentation locations
|
|
|
|
---
|
|
|
|
## README.md Patterns
|
|
|
|
Typical sections:
|
|
- **Installation**: Version requirements, dependencies
|
|
- **Usage**: Function calls, CLI commands
|
|
- **Configuration**: Environment vars, config files
|
|
- **API**: Endpoint references
|
|
|
|
---
|
|
|
|
## CLAUDE.md Patterns
|
|
|
|
Typical sections:
|
|
- **Project Context**: Tech stack versions
|
|
- **File Structure**: Directory layout
|
|
- **Commands**: Available operations
|
|
- **Workflows**: Process descriptions
|
|
|
|
---
|
|
|
|
## Code Documentation
|
|
|
|
### Docstrings
|
|
- Function signatures
|
|
- Parameters and types
|
|
- Return values
|
|
- Raised exceptions
|
|
|
|
### Type Hints
|
|
- Should match docstring types
|
|
- Verify consistency
|
|
|
|
### Inline Comments
|
|
- References to other code
|
|
- TODO markers
|
|
- Warning notes
|
|
|
|
---
|
|
|
|
## File Inventory
|
|
|
|
Standard documentation files to check:
|
|
- `README.md` (root and subdirectories)
|
|
- `CLAUDE.md`
|
|
- `CONTRIBUTING.md`
|
|
- `CHANGELOG.md`
|
|
- `docs/**/*.md`
|
|
- API documentation
|
|
- Configuration references
|