Analyze why a convention wasn't followed and create a GitHub issue to improve plugin documentation
Analyzes convention violations and creates GitHub issues to improve plugin documentation.
/plugin marketplace add RasmusGodske/dev-agent-workflow/plugin install project-roles@dev-agent-workflowwhat convention was missed or why something wasn't followedThe user has noticed that a convention or pattern wasn't followed in their project and wants to help improve the plugin to prevent future mistakes.
$ARGUMENTS
You cannot see the plugin source code right now. The plugin files are installed in Claude Code's plugin directory, not in this project.
However, you can still create a valuable improvement issue based on:
The plugin you're helping improve lives at: https://github.com/RasmusGodske/dev-agent-workflow
It has this structure:
dev-agent-workflow/
├── project-roles/ # Main plugin
│ ├── .claude-plugin/
│ │ └── plugin.json # Plugin metadata
│ ├── commands/
│ │ ├── roles/ # Role commands
│ │ │ ├── techlead.md
│ │ │ ├── backend-engineer.md
│ │ │ ├── frontend-engineer.md
│ │ │ ├── fullstack-engineer.md
│ │ │ └── agent-engineer.md
│ │ └── linear/ # Linear workflow commands
│ │ ├── start-project.md
│ │ ├── work-on-issue.md
│ │ └── review-project.md
│ ├── skills/ # Auto-activating skills
│ │ ├── backend-developer/SKILL.md
│ │ ├── frontend-developer/SKILL.md
│ │ ├── laravel-data-writer/SKILL.md
│ │ ├── php-test-writer/SKILL.md
│ │ └── linear-issue-writer/SKILL.md
│ └── agents/ # Subagents with separate context
│ ├── backend-reviewer.md
│ └── frontend-reviewer.md
│
└── rules-boilerplate/ # Convention templates plugin
└── commands/
└── setup-rules.md
How the plugin works:
/roles/backend-engineer) - Expand prompts in the main conversationProvide a structured analysis and create a GitHub issue to improve the plugin documentation.
First, think about what you saw when the relevant command/skill was invoked:
/roles/backend-engineer), what instructions did you receive?Be specific about what you remember seeing. This is valuable data about what the current documentation says.
Based on what the user observed and what you remember from the expanded prompts, clearly state what convention/pattern should have been followed but wasn't.
Be specific:
Be honest about gaps in the current plugin documentation. Consider:
Which plugin files should have prevented this mistake?
Use the repository structure shown above to identify the likely files. Based on what component was involved:
project-roles/commands/roles/[role-name].md (e.g., backend-engineer.md)project-roles/commands/linear/[command-name].md (e.g., work-on-issue.md)project-roles/skills/[skill-name]/SKILL.md (e.g., backend-developer/SKILL.md)project-roles/agents/[agent-name].md (e.g., backend-reviewer.md)Be honest if you're not certain. It's okay to say "likely backend-engineer.md based on the role that was active" rather than claiming certainty you don't have.
IMPORTANT: Focus on the SINGLE MOST IMPACTFUL change.
Don't propose 3-5 improvements. Identify the ONE change that would have prevented this specific mistake. You can mention other potential improvements briefly, but provide detailed markdown for only ONE primary change.
For the primary improvement, specify:
Location: project-roles/path/to/file.md
Change: Show the actual markdown/text to add or modify (keep it focused - 50-150 words)
IMPORTANT - Sanitize your examples:
## CRITICAL: [Requirement Name]
**BEFORE [action], you MUST:**
1. [Specific step]
2. [Specific step]
❌ WRONG: [Show what not to do - use GENERIC examples]
✅ RIGHT: [Show what to do - use GENERIC examples]
Why: Explain how this prevents the mistake from happening again (2-3 sentences)
Types of improvements to consider:
CRITICAL: Remove all sensitive information before creating the issue.
What to REMOVE:
/home/company/app/Models/User.php → "a Laravel model file")What to KEEP:
project-roles/skills/backend-developer/SKILL.md)Sanitization examples:
❌ Before: "After completing RAS-60 implementation..." ✅ After: "After completing the implementation..."
❌ Before: "Should we move to RAS-61?" ✅ After: "Should we move to the next task?"
❌ Before: "When implementing the UserSubscriptionService for Acme Corp's billing system..." ✅ After: "When implementing a service class with database interactions..."
❌ Before: "File at /home/acme/app/Services/Billing/UserSubscriptionService.php" ✅ After: "A Laravel service class"
❌ Before: "The customer_stripe_id field in our payments table" ✅ After: "A foreign key field in a database table"
VALIDATION - Before finalizing, scan your draft for:
Create a sanitized issue following this structure. Keep it concise - aim for under 1000 words total.
Include what you experienced - this is valuable context about the current state of the documentation.
Use this exact markdown template:
## What Convention/Pattern Was Missed?
[2-3 sentences: What should have been followed but wasn't]
## What I Saw When Invoked
[2-4 sentences: What instructions/checklist you received when the command/skill was invoked. If you don't remember seeing anything about this requirement, say that clearly.]
## Task Context (Generic)
[1-2 sentences: Generic description of the task type - no company specifics]
## Why Wasn't It Clear?
[2-4 sentences: Analysis of the documentation gap based on what you experienced]
## Which Documentation Files Need Updates
- `project-roles/path/to/file.md`
## Proposed Improvement
**File:** `project-roles/path/to/file.md`
**Change:**
```markdown
[Your proposed markdown text to add/modify - keep focused, 50-150 words]
Why: [2-3 sentences: How this prevents future mistakes]
[1-2 sentences: Any other relevant observations, or note if this happens frequently]
Component: [Role Command / Linear Command / Skill / Agent] - [specific name] Plugin: project-roles
**Length Guidelines:**
- What I Saw When Invoked: 2-4 sentences
- Proposed Improvement: 50-150 words of markdown
- Other sections: 1-4 sentences each
- Target: 500-1000 words total
### Step 8: Show Draft for Approval
Display the complete sanitized issue to the user with clear formatting:
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ DRAFT GITHUB ISSUE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Title: [Convention] [Brief description]
[Full formatted markdown body from Step 6 here]
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Then ask:
**IMPORTANT: Please review this draft carefully for any sensitive information.**
Would you like me to:
1. **Create GitHub issue** - Post to RasmusGodske/dev-agent-workflow using gh CLI
2. **Save to file** - Save the draft locally for manual posting later
3. **Cancel** - Don't create the issue
### Step 9: Create GitHub Issue (if approved)
If the user approves option 1, use the GitHub CLI to create the issue directly:
```bash
gh issue create \
--repo RasmusGodske/dev-agent-workflow \
--title "[Convention] [your title]" \
--body "$(cat <<'EOF'
[Full markdown body from Step 7]
EOF
)" \
--label "claude-code-feedback"
Important notes:
cat <<'EOF' ... EOF) to properly handle the multi-line body'EOF' prevent variable expansionThen return the issue URL to the user:
✅ Issue created successfully!
📍 View it here: https://github.com/RasmusGodske/dev-agent-workflow/issues/[number]
Thank you for helping improve the plugin! This feedback will help make the documentation clearer for everyone.
If user chose option 2, save the issue to a local file:
cat > convention-improvement-draft.md <<'EOF'
# Title: [Convention] [title]
[Full markdown body]
EOF
Then tell the user:
✅ Draft saved to: convention-improvement-draft.md
You can review this file and manually create the issue at:
https://github.com/RasmusGodske/dev-agent-workflow/issues/new
Thank you for helping improve the plugin!
This is a feedback loop for improving the plugin based on real mistakes in real projects. The goal is to make conventions so clear and prominent that they're hard to miss.
Your analysis should be thorough, your sanitization should be paranoid, and your proposed improvements should be concrete and implementable.