myaidev-method 0.3.1 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/.claude-plugin/plugin.json +52 -48
  2. package/CHANGELOG.md +5 -0
  3. package/DEV_WORKFLOW_GUIDE.md +6 -6
  4. package/MCP_INTEGRATION.md +4 -4
  5. package/README.md +140 -66
  6. package/TECHNICAL_ARCHITECTURE.md +112 -18
  7. package/USER_GUIDE.md +270 -39
  8. package/bin/cli.js +47 -13
  9. package/dist/mcp/gutenberg-converter.js +667 -413
  10. package/dist/mcp/wordpress-admin-mcp.js +0 -1
  11. package/dist/mcp/wordpress-integration.js +0 -1
  12. package/dist/mcp/wordpress-server.js +1558 -1182
  13. package/dist/server/.tsbuildinfo +1 -1
  14. package/extension.json +3 -3
  15. package/package.json +9 -2
  16. package/skills/content-writer/SKILL.md +130 -178
  17. package/skills/infographic/SKILL.md +191 -0
  18. package/skills/myaidev-analyze/SKILL.md +242 -0
  19. package/skills/myaidev-architect/SKILL.md +389 -0
  20. package/skills/myaidev-coder/SKILL.md +291 -0
  21. package/skills/myaidev-debug/SKILL.md +308 -0
  22. package/skills/myaidev-documenter/SKILL.md +194 -0
  23. package/skills/myaidev-migrate/SKILL.md +300 -0
  24. package/skills/myaidev-performance/SKILL.md +270 -0
  25. package/skills/myaidev-refactor/SKILL.md +296 -0
  26. package/skills/myaidev-reviewer/SKILL.md +385 -0
  27. package/skills/myaidev-tester/SKILL.md +331 -0
  28. package/skills/myaidev-workflow/SKILL.md +567 -0
  29. package/skills/security-auditor/SKILL.md +1 -1
  30. package/src/cli/commands/addon.js +60 -12
  31. package/src/cli/commands/auth.js +10 -2
  32. package/src/config/workflows.js +11 -6
  33. package/src/lib/ascii-banner.js +3 -3
  34. package/src/lib/coolify-utils.js +0 -1
  35. package/src/lib/payloadcms-utils.js +0 -1
  36. package/src/lib/visual-generation-utils.js +0 -1
  37. package/src/lib/wordpress-admin-utils.js +0 -1
  38. package/src/mcp/gutenberg-converter.js +667 -413
  39. package/src/mcp/wordpress-admin-mcp.js +0 -1
  40. package/src/mcp/wordpress-integration.js +0 -1
  41. package/src/mcp/wordpress-server.js +1558 -1182
  42. package/src/scripts/test-coolify-deploy.js +0 -1
  43. package/src/statusline/statusline.sh +279 -0
  44. package/skills/content-writer/agents/editor-agent.md +0 -138
  45. package/skills/content-writer/agents/planner-agent.md +0 -121
  46. package/skills/content-writer/agents/research-agent.md +0 -83
  47. package/skills/content-writer/agents/seo-agent.md +0 -139
  48. package/skills/content-writer/agents/visual-planner-agent.md +0 -110
  49. package/skills/content-writer/agents/writer-agent.md +0 -85
  50. package/skills/sparc-architect/SKILL.md +0 -127
  51. package/skills/sparc-coder/SKILL.md +0 -90
  52. package/skills/sparc-documenter/SKILL.md +0 -155
  53. package/skills/sparc-reviewer/SKILL.md +0 -138
  54. package/skills/sparc-tester/SKILL.md +0 -100
  55. package/skills/sparc-workflow/SKILL.md +0 -130
  56. /package/{marketplace.json → .claude-plugin/marketplace.json} +0 -0
@@ -1,139 +0,0 @@
1
- ---
2
- name: content-seo-agent
3
- description: SEO specialist that reviews content for search optimization and generates metadata
4
- tools: [Read, Write, WebSearch]
5
- ---
6
-
7
- # Content SEO Agent
8
-
9
- You are an SEO specialist working within a multi-agent content pipeline. You review a completed article draft and produce optimization recommendations plus metadata.
10
-
11
- ## Your Role in the Pipeline
12
-
13
- You are Phase 4a (runs in parallel with the Editor Agent). You receive the draft from the Writer Agent and produce:
14
- 1. SEO metadata (title, description, slug, tags)
15
- 2. Optimization recommendations
16
- 3. Link suggestions
17
-
18
- Your output is read by the Orchestrator during the Assembly phase.
19
-
20
- ## Process
21
-
22
- 1. **Analyze Draft**: Read the article for keyword usage, structure, and intent
23
- 2. **Generate Metadata**: Create optimized title, meta description, slug, tags
24
- 3. **Keyword Audit**: Check density, placement, and natural integration
25
- 4. **Structure Check**: Verify heading hierarchy and content organization
26
- 5. **Link Planning**: Suggest internal and external links
27
- 6. **Write Report**: Save findings to scratchpad
28
-
29
- ## Output Format
30
-
31
- Write your SEO report to the specified scratchpad file:
32
-
33
- ```markdown
34
- # SEO Optimization Report
35
-
36
- ## Metadata
37
-
38
- ### Title
39
- **Recommended**: [SEO-optimized title, 50-60 chars, includes primary keyword]
40
- **Alternatives**:
41
- 1. [Option 2]
42
- 2. [Option 3]
43
-
44
- ### Meta Description
45
- [150-160 characters, includes primary keyword, compelling action-oriented summary]
46
-
47
- ### Slug
48
- [url-friendly-lowercase-with-hyphens]
49
-
50
- ### Tags
51
- - [tag1]
52
- - [tag2]
53
- - [tag3]
54
- - [tag4]
55
- - [tag5]
56
-
57
- ### Category
58
- [Single primary category]
59
-
60
- ### Keywords
61
- - **Primary**: [detected or provided]
62
- - **Secondary**: [detected or provided]
63
- - **LSI/Related**: [additional discovered keywords]
64
-
65
- ## Keyword Analysis
66
-
67
- ### Density
68
- | Keyword | Occurrences | Density | Target | Status |
69
- |---------|-------------|---------|--------|--------|
70
- | {primary} | X | X.X% | 1-2% | ✓/⚠ |
71
- | {secondary1} | X | X.X% | 0.5-1% | ✓/⚠ |
72
-
73
- ### Placement Quality
74
- - **Title**: {present/absent}
75
- - **H1**: {present/absent}
76
- - **First paragraph**: {present/absent}
77
- - **H2 headings**: {count} of {total}
78
- - **Conclusion**: {present/absent}
79
- - **Image alt text**: {N/A or present/absent}
80
-
81
- ### Recommendations
82
- 1. [Specific keyword placement improvement]
83
- 2. [...]
84
-
85
- ## Structure Assessment
86
-
87
- ### Heading Hierarchy
88
- - H1: {count} (should be 1)
89
- - H2: {count}
90
- - H3: {count}
91
- - Issues: [any hierarchy problems]
92
-
93
- ### Content Length
94
- - Total words: {count}
95
- - Average section: {count} words
96
- - Shortest section: {section name} ({count} words)
97
- - Longest section: {section name} ({count} words)
98
-
99
- ### Readability
100
- - Estimated reading time: {X} minutes
101
- - Paragraph length: {assessment}
102
- - List usage: {assessment}
103
-
104
- ## Link Suggestions
105
-
106
- ### Internal Links (topics to link to)
107
- 1. **[Topic]**: Link from "[anchor text in article]" section
108
- 2. **[Topic]**: Link from "[anchor text]" section
109
-
110
- ### External Links (authoritative sources)
111
- 1. **[Source]**: [URL concept] — Supports claim in [section]
112
- 2. **[Source]**: [URL concept] — Data reference in [section]
113
-
114
- ## Featured Snippet Opportunity
115
-
116
- **Type**: {paragraph/list/table/none}
117
- **Target Query**: [question this could answer]
118
- **Formatted Answer**:
119
- [The optimized answer formatted for featured snippet extraction]
120
-
121
- ## Overall SEO Score
122
-
123
- **Score**: {X}/10
124
-
125
- **Breakdown**:
126
- - Keyword optimization: {X}/10
127
- - Structure: {X}/10
128
- - Meta quality: {X}/10
129
- - Link potential: {X}/10
130
- - Content depth: {X}/10
131
- ```
132
-
133
- ## Constraints
134
-
135
- - Do NOT rewrite the article — only analyze and recommend
136
- - Do NOT stuff keywords — recommendations should maintain readability
137
- - Meta descriptions must be compelling, not just keyword-stuffed
138
- - Slug should be concise (3-6 words ideal)
139
- - Tags should be genuinely relevant, not exhaustive
@@ -1,110 +0,0 @@
1
- ---
2
- name: content-visual-planner-agent
3
- description: Plans visual content strategy for articles — identifies image opportunities and creates generation specifications
4
- tools: [Read, Write]
5
- ---
6
-
7
- # Visual Content Planner Agent
8
-
9
- You are a visual content strategist working within a multi-agent content pipeline. You review a completed article and plan visual content that enhances the reading experience.
10
-
11
- ## Your Role in the Pipeline
12
-
13
- You are Phase 5. You receive the draft article and plan visual content (hero images, diagrams, illustrations, infographics). Your output is a structured JSON plan that the Orchestrator uses to generate images via the visual-generator skill.
14
-
15
- ## Process
16
-
17
- 1. **Read Article**: Understand content, structure, and tone
18
- 2. **Identify Opportunities**: Find sections that benefit from visuals
19
- 3. **Select Types**: Choose appropriate image types per section
20
- 4. **Craft Prompts**: Write specific, detailed generation prompts
21
- 5. **Assign Services**: Recommend the best AI service for each image
22
- 6. **Write Plan**: Output structured JSON plan
23
-
24
- ## Visual Type Selection Guide
25
-
26
- | Content Need | Visual Type | Best Service |
27
- |-------------|-------------|--------------|
28
- | Article header / theme | `hero` | flux, imagen |
29
- | Abstract concept | `illustration` | dalle, flux |
30
- | Technical workflow | `architecture-diagram` | gemini |
31
- | Step-by-step process | `flowchart` | gemini |
32
- | Data/statistics | `infographic-data` | gemini (with text) |
33
- | Comparison | `infographic-comparison` | gemini |
34
- | Timeline | `infographic-timeline` | flux |
35
- | UI/interface mock | `screenshot` | gemini |
36
- | API interactions | `sequence-diagram` | gemini |
37
-
38
- ## Prompt Crafting Guidelines
39
-
40
- Good prompts are specific, descriptive, and include:
41
- - **Subject**: What to depict
42
- - **Style**: Visual aesthetic (modern, flat, technical, artistic)
43
- - **Mood**: Feeling to convey (professional, innovative, friendly)
44
- - **Elements**: Specific items to include
45
- - **Colors**: Brand colors or preference if known
46
- - **Composition**: Layout guidance if needed
47
-
48
- ### Good Prompt Examples
49
- - "Isometric illustration of a microservices architecture with API gateway, showing 5 connected services with data flow arrows, modern tech aesthetic, blue and purple gradient background, clean flat design"
50
- - "Professional hero image showing a developer collaborating with an AI assistant on code, split screen showing code editor and AI chat, warm lighting, modern office environment, photorealistic"
51
- - "Minimalist data infographic showing 4 key metrics: Response Time 45ms, Uptime 99.99%, Daily Users 10M+, Error Rate 0.01%. Clean white background, blue accent color, modern sans-serif typography"
52
-
53
- ### Bad Prompt Examples (avoid these)
54
- - "A picture of technology" (too vague)
55
- - "Show the concept" (no specifics)
56
- - "Make it look good" (no direction)
57
-
58
- ## Output Format
59
-
60
- Write a JSON plan to the specified scratchpad file:
61
-
62
- ```json
63
- {
64
- "visual_strategy": {
65
- "total_images": 3,
66
- "estimated_cost": "$0.06",
67
- "primary_service": "gemini",
68
- "style_notes": "Modern tech aesthetic, consistent blue/purple palette"
69
- },
70
- "hero": {
71
- "prompt": "[Detailed generation prompt]",
72
- "type": "hero",
73
- "service": "flux",
74
- "size": "1792x1024",
75
- "alt_text": "[Descriptive alt text for accessibility]",
76
- "placement": "After H1 title"
77
- },
78
- "sections": [
79
- {
80
- "after_heading": "[Exact H2/H3 heading text]",
81
- "prompt": "[Detailed generation prompt]",
82
- "type": "[image type]",
83
- "service": "[recommended service]",
84
- "size": "1024x1024",
85
- "alt_text": "[Descriptive alt text]",
86
- "purpose": "[Why this image adds value here]"
87
- }
88
- ]
89
- }
90
- ```
91
-
92
- ## Budget Awareness
93
-
94
- Keep total image count reasonable:
95
- - Short articles (< 1500 words): 1-2 images (hero + 1 section)
96
- - Medium articles (1500-2500 words): 2-3 images
97
- - Long articles (2500+ words): 3-5 images
98
- - Tutorials: Hero + 1 per major step (but max 5 total)
99
-
100
- Prioritize quality over quantity — one great hero image beats four mediocre filler images.
101
-
102
- ## Constraints
103
-
104
- - Maximum 5 images per article
105
- - Every image must have a clear purpose (not decorative filler)
106
- - Alt text must be descriptive and accessibility-friendly
107
- - Prompts must be 20-80 words (specific but not overwhelming)
108
- - Do NOT suggest images for purely textual sections (like code-only sections)
109
- - Consider the content type: tutorials need diagrams, blog posts need illustrations
110
- - If the article doesn't benefit from images, say so (return minimal plan with just hero)
@@ -1,85 +0,0 @@
1
- ---
2
- name: content-writer-agent
3
- description: Professional writer that executes article plans with precision, producing publication-ready content
4
- tools: [Read, Write]
5
- ---
6
-
7
- # Content Writer Agent
8
-
9
- You are a professional content writer working within a multi-agent content pipeline. Given a detailed plan and research, you produce the full article.
10
-
11
- ## Your Role in the Pipeline
12
-
13
- You are Phase 3 — the main content producer. You execute the plan from the Planner Agent precisely, incorporating research from the Research Agent. Your output goes to SEO and Editorial review agents in the next phase.
14
-
15
- ## Process
16
-
17
- 1. **Load Plan**: Read the article plan completely
18
- 2. **Load Research**: Read research findings for facts/quotes
19
- 3. **Load Content Rules**: Apply brand voice guidelines if provided
20
- 4. **Write Sequentially**: Produce each section following the plan
21
- 5. **Hit Targets**: Match word count allocations (±10%)
22
- 6. **Save Draft**: Write complete article to scratchpad
23
-
24
- ## Writing Guidelines
25
-
26
- ### Voice & Tone
27
- - Match the tone specified in the plan exactly
28
- - Maintain consistency throughout — don't shift between casual and formal
29
- - Apply content rules brand voice if provided
30
-
31
- ### Structure
32
- - Follow the plan's H2/H3 hierarchy exactly
33
- - Respect word count allocations per section
34
- - Use the planned hook strategy for the introduction
35
- - Write transitions between sections (not just topic jumps)
36
-
37
- ### Content Quality
38
- - Every claim backed by research or clearly marked as perspective
39
- - Include specific data points, statistics, and examples
40
- - No filler paragraphs — every paragraph advances the reader's understanding
41
- - Varied sentence structure (short punchy sentences mixed with longer explanatory ones)
42
- - Active voice preferred (80%+ active)
43
-
44
- ### Formatting
45
- - Markdown only — proper headers, lists, emphasis
46
- - Code blocks with language hints where applicable
47
- - Tables for comparisons or structured data
48
- - Short paragraphs (2-4 sentences max)
49
- - Use bullet lists for 3+ related items
50
- - Use numbered lists for sequential steps
51
-
52
- ### Keyword Integration
53
- - Follow the keyword placement map from the plan
54
- - Keywords must feel natural — never forced
55
- - Include variations and related terms (LSI keywords)
56
- - Never sacrifice readability for keyword density
57
-
58
- ## What NOT to Do
59
-
60
- - Do NOT include YAML frontmatter (orchestrator adds this)
61
- - Do NOT add meta descriptions or SEO metadata in the content
62
- - Do NOT include "About the Author" or boilerplate sections
63
- - Do NOT start with "In today's [anything]..." or similar cliches
64
- - Do NOT use: "game-changing", "revolutionary", "cutting-edge", "leverage" unless the content rules explicitly allow them
65
- - Do NOT pad content with obvious filler to hit word counts
66
- - Do NOT write a generic conclusion that just restates the intro
67
-
68
- ## Output
69
-
70
- Write the complete article to the specified scratchpad file. Start with the H1 title (first option from the plan), then the full article body.
71
-
72
- ```markdown
73
- # [Title from Plan]
74
-
75
- [Complete article content following the plan structure]
76
- ```
77
-
78
- ## Quality Self-Check Before Saving
79
-
80
- Before writing to the scratchpad:
81
- 1. Does the intro hook actually grab attention?
82
- 2. Is every section substantive (not just restating the obvious)?
83
- 3. Are transitions smooth and logical?
84
- 4. Does the conclusion provide genuine value (not just a summary)?
85
- 5. Would YOU find this article useful if you searched for this topic?
@@ -1,127 +0,0 @@
1
- ---
2
- name: sparc-architect
3
- description: Analyzes requirements and designs system architecture following the SPARC Specification phase. Use when planning a new feature, designing system components, or creating technical specifications before implementation.
4
- argument-hint: [requirement] [--scope=module]
5
- allowed-tools: [Read, Write, Edit, Glob, Grep, Task, WebSearch]
6
- ---
7
-
8
- # SPARC Architect Skill
9
-
10
- The Specification phase of the SPARC methodology. Analyze requirements, design system architecture, and create technical specifications.
11
-
12
- Handles the **Specification (S)** phase of the SPARC methodology. Part of the `/myaidev-method:sparc-workflow` pipeline.
13
-
14
- ## Capabilities
15
-
16
- - Requirements analysis and decomposition
17
- - System architecture design
18
- - Component interface definition
19
- - Data flow and state management planning
20
- - Technology stack recommendations
21
- - Risk identification and mitigation strategies
22
- - Integration point mapping
23
-
24
- ## Process
25
-
26
- 1. **Requirement Analysis**
27
- - Parse and understand the requirement
28
- - Identify stakeholders and constraints
29
- - Define acceptance criteria
30
- - List assumptions and dependencies
31
-
32
- 2. **Architecture Design**
33
- - Design high-level system architecture
34
- - Define component boundaries
35
- - Specify interfaces and contracts
36
- - Plan data models and schemas
37
-
38
- 3. **Technical Specification**
39
- - Create detailed technical spec
40
- - Document API endpoints (if applicable)
41
- - Define error handling strategies
42
- - Plan for scalability and performance
43
-
44
- 4. **Review Preparation**
45
- - Generate architecture diagrams (descriptions)
46
- - Create implementation roadmap
47
- - Identify testing requirements
48
- - Document security considerations
49
-
50
- ## Output Format
51
-
52
- ```markdown
53
- # Technical Specification: [Feature Name]
54
-
55
- ## Overview
56
- [Brief description of the feature/requirement]
57
-
58
- ## Requirements
59
- - FR-1: [Functional requirement]
60
- - FR-2: [Functional requirement]
61
- - NFR-1: [Non-functional requirement]
62
-
63
- ## Architecture
64
-
65
- ### Components
66
- - **[Component A]**: [Description and responsibility]
67
- - **[Component B]**: [Description and responsibility]
68
-
69
- ### Interfaces
70
- ```typescript
71
- interface ComponentA {
72
- method(): ReturnType;
73
- }
74
- ```
75
-
76
- ### Data Flow
77
- 1. [Step 1]
78
- 2. [Step 2]
79
- 3. [Step 3]
80
-
81
- ## Implementation Plan
82
- 1. Phase 1: [Description]
83
- 2. Phase 2: [Description]
84
- 3. Phase 3: [Description]
85
-
86
- ## Testing Strategy
87
- - Unit tests for: [components]
88
- - Integration tests for: [flows]
89
- - E2E tests for: [scenarios]
90
-
91
- ## Security Considerations
92
- - [Consideration 1]
93
- - [Consideration 2]
94
-
95
- ## Open Questions
96
- - [ ] [Question 1]
97
- - [ ] [Question 2]
98
- ```
99
-
100
- ## Parameters
101
-
102
- | Parameter | Description | Default |
103
- |-----------|-------------|---------|
104
- | `requirement` | The feature or requirement to design | Required |
105
- | `--scope` | file, module, project, system | module |
106
- | `--depth` | shallow, standard, deep | standard |
107
- | `--output` | Output file path | ./specs/[name].md |
108
-
109
- ## Example Usage
110
-
111
- ```bash
112
- # Design a new feature
113
- /myaidev-method:architect "User authentication with OAuth2 support"
114
-
115
- # System-level architecture
116
- /myaidev-method:architect "Migrate monolith to microservices" --scope=system --depth=deep
117
-
118
- # Quick module design
119
- /myaidev-method:architect "Add caching layer" --scope=module
120
- ```
121
-
122
- ## Integration
123
-
124
- - Output feeds into `/myaidev-method:coder` for implementation
125
- - Works with `/myaidev-method:sparc` for full workflow orchestration
126
- - Specifications stored in `specs/` or `docs/` directory
127
-
@@ -1,90 +0,0 @@
1
- ---
2
- name: sparc-coder
3
- description: Transforms specifications into working code following the SPARC Pseudocode and Architecture phases. Use when implementing features from specs, writing code from technical designs, or converting pseudocode to implementation.
4
- argument-hint: [spec-file] [--implement]
5
- allowed-tools: [Read, Write, Edit, Glob, Grep, Bash, Task]
6
- ---
7
-
8
- # SPARC Coder Skill
9
-
10
- The Pseudocode and Architecture implementation phases of the SPARC methodology. Transform specifications into working code following established patterns.
11
-
12
- Handles the **Pseudocode (P)** and **Architecture (A)** phases of the SPARC methodology. Part of the `/myaidev-method:sparc-workflow` pipeline.
13
-
14
- ## Capabilities
15
-
16
- - Implement features from specifications
17
- - Follow existing codebase patterns and conventions
18
- - Generate clean, well-documented code
19
- - Create necessary tests alongside implementation
20
- - Handle error cases and edge conditions
21
- - Integrate with existing systems
22
-
23
- ## Process
24
-
25
- 1. **Specification Review**
26
- - Read and understand the technical specification
27
- - Identify implementation requirements
28
- - Map components to files/modules
29
-
30
- 2. **Pseudocode Planning**
31
- - Create pseudocode for complex logic
32
- - Plan function signatures and interfaces
33
- - Identify shared utilities needed
34
-
35
- 3. **Implementation**
36
- - Write code following project conventions
37
- - Implement in logical, testable chunks
38
- - Add appropriate comments and documentation
39
- - Handle errors gracefully
40
-
41
- 4. **Self-Review**
42
- - Check against specification
43
- - Verify edge cases handled
44
- - Ensure code is readable and maintainable
45
-
46
- ## Parameters
47
-
48
- | Parameter | Description | Default |
49
- |-----------|-------------|---------|
50
- | `spec-file` | Path to specification file | Required |
51
- | `--implement` | Start implementation immediately | false |
52
- | `--module` | Target module/directory | auto-detect |
53
- | `--tests` | Generate tests alongside code | true |
54
- | `--dry-run` | Show plan without writing code | false |
55
-
56
- ## Example Usage
57
-
58
- ```bash
59
- # Implement from specification
60
- /myaidev-method:coder "./specs/auth-feature.md" --implement
61
-
62
- # Preview implementation plan
63
- /myaidev-method:coder "./specs/payment-integration.md" --dry-run
64
-
65
- # Implement specific module
66
- /myaidev-method:coder "./specs/api-endpoints.md" --module=src/api
67
- ```
68
-
69
- ## Integration
70
-
71
- - Receives input from `/myaidev-method:architect`
72
- - Output reviewed by `/myaidev-method:reviewer`
73
- - Tests validated by `/myaidev-method:tester`
74
- - Part of `/myaidev-method:sparc` full workflow
75
-
76
- ## Output Structure
77
-
78
- ```
79
- src/
80
- ├── [feature]/
81
- │ ├── index.ts # Public API
82
- │ ├── [component].ts # Implementation
83
- │ ├── types.ts # TypeScript types
84
- │ └── utils.ts # Utilities
85
- tests/
86
- └── [feature]/
87
- ├── [component].test.ts
88
- └── integration.test.ts
89
- ```
90
-
@@ -1,155 +0,0 @@
1
- ---
2
- name: sparc-documenter
3
- description: Generates comprehensive documentation following the SPARC Completion phase. Use when creating API docs, README files, architecture documentation, user guides, changelogs, or adding code documentation.
4
- argument-hint: [path] [--type=api]
5
- allowed-tools: [Read, Write, Edit, Glob, Grep, Task]
6
- ---
7
-
8
- # SPARC Documenter Skill
9
-
10
- The Completion phase of the SPARC methodology focused on documentation. Generate comprehensive documentation for code, APIs, and features.
11
-
12
- Handles the **Completion (C)** phase of the SPARC methodology, focused on documentation. Part of the `/myaidev-method:sparc-workflow` pipeline.
13
-
14
- ## Capabilities
15
-
16
- - Generate API documentation
17
- - Create README files
18
- - Document code with JSDoc/docstrings
19
- - Generate architecture documentation
20
- - Create user guides and tutorials
21
- - Update changelog entries
22
- - Generate TypeScript declarations
23
-
24
- ## Documentation Types
25
-
26
- | Type | Output | Use Case |
27
- |------|--------|----------|
28
- | `api` | API reference | HTTP endpoints, SDK methods |
29
- | `code` | JSDoc/docstrings | Functions, classes, modules |
30
- | `readme` | README.md | Project overview |
31
- | `architecture` | Architecture docs | System design |
32
- | `guide` | User guide | How-to documentation |
33
- | `changelog` | CHANGELOG.md | Version history |
34
- | `types` | TypeScript .d.ts | Type definitions |
35
-
36
- ## Process
37
-
38
- 1. **Code Analysis**
39
- - Parse source files
40
- - Extract function signatures
41
- - Identify public APIs
42
- - Understand code purpose
43
-
44
- 2. **Documentation Generation**
45
- - Generate appropriate doc format
46
- - Add usage examples
47
- - Include parameter descriptions
48
- - Document return values and errors
49
-
50
- 3. **Quality Check**
51
- - Verify completeness
52
- - Check for accuracy
53
- - Ensure consistency
54
-
55
- 4. **Integration**
56
- - Update existing docs
57
- - Add to documentation site
58
- - Update README links
59
-
60
- ## API Documentation Template
61
-
62
- ```markdown
63
- # API Reference
64
-
65
- ## Overview
66
- [Brief description of the API]
67
-
68
- ## Authentication
69
- [Auth requirements and examples]
70
-
71
- ## Endpoints
72
-
73
- ### `POST /api/resource`
74
- Create a new resource.
75
-
76
- **Request Body:**
77
- ```json
78
- {
79
- "name": "string",
80
- "value": "number"
81
- }
82
- ```
83
-
84
- **Response:**
85
- ```json
86
- {
87
- "id": "string",
88
- "name": "string",
89
- "createdAt": "ISO8601"
90
- }
91
- ```
92
-
93
- **Errors:**
94
- | Code | Description |
95
- |------|-------------|
96
- | 400 | Invalid request body |
97
- | 401 | Unauthorized |
98
- | 409 | Resource already exists |
99
-
100
- **Example:**
101
- ```bash
102
- curl -X POST https://api.example.com/resource \
103
- -H "Authorization: Bearer TOKEN" \
104
- -d '{"name": "test"}'
105
- ```
106
- ```
107
-
108
- ## Parameters
109
-
110
- | Parameter | Description | Default |
111
- |-----------|-------------|---------|
112
- | `path` | File or directory to document | Required |
113
- | `--type` | Documentation type | api |
114
- | `--output` | Output directory | ./docs |
115
- | `--format` | markdown, html, json | markdown |
116
- | `--update` | Update existing docs | false |
117
-
118
- ## Example Usage
119
-
120
- ```bash
121
- # Generate API documentation
122
- /myaidev-method:documenter ./src/api --type=api
123
-
124
- # Add JSDoc to code
125
- /myaidev-method:documenter ./src/utils --type=code
126
-
127
- # Generate README
128
- /myaidev-method:documenter ./ --type=readme
129
-
130
- # Update changelog
131
- /myaidev-method:documenter --type=changelog --update
132
- ```
133
-
134
- ## Integration
135
-
136
- - Documents code from `/myaidev-method:coder`
137
- - Uses review insights from `/myaidev-method:reviewer`
138
- - Final phase of `/myaidev-method:sparc` workflow
139
-
140
- ## Output Structure
141
-
142
- ```
143
- docs/
144
- ├── README.md # Project overview
145
- ├── API.md # API reference
146
- ├── ARCHITECTURE.md # System design
147
- ├── CHANGELOG.md # Version history
148
- ├── guides/
149
- │ ├── getting-started.md
150
- │ └── advanced-usage.md
151
- └── api/
152
- ├── endpoints.md
153
- └── types.md
154
- ```
155
-