issue-writer
Skill for creating and drafting issue documents in the specified format, including bugs, features, RFCs, ADRs, tasks, retrospectives, etc. Use when you need to document software issues, features, decisions, or work items in .docs/issues/ or _docs/issues/ folders.
When & Why to Use This Skill
The Issue Writer Claude skill automates the creation of standardized technical documentation, including bug reports, feature plans, RFCs, and ADRs. By leveraging structured markdown templates and YAML frontmatter, it ensures consistency across software project repositories and streamlines the developer workflow for documenting critical decisions and tasks.
Use Cases
- Bug Reporting: Quickly generate structured bug reports with severity, descriptions, and reproduction steps to maintain a high-quality issue tracker.
- Architecture Decision Records (ADR): Document significant technical choices and their rationales in a consistent format to preserve project history.
- Feature Proposals (RFC): Draft comprehensive Request for Comments documents to facilitate team collaboration and feedback on new technical designs.
- Project Retrospectives: Standardize the documentation of post-sprint learnings and action items to improve team velocity and process.
- Task Management: Create detailed task descriptions within the codebase documentation folder to keep development goals aligned with technical requirements.
| name | issue-writer |
|---|---|
| description | Skill for creating and drafting issue documents in the specified format, including bugs, features, RFCs, ADRs, tasks, retrospectives, etc. Use when you need to document software issues, features, decisions, or work items in .docs/issues/ or _docs/issues/ folders. |
Issue Writer
Overview
This skill enables the creation of concise, one-page technical documents for software issues, features, decisions, and work items, following a standardized YAML frontmatter and markdown structure.
Workflow
- Determine the type of document needed (Bug, Feature Plan, RFC, ADR, Task, Retrospective).
- Gather required information (title, description, status, etc.).
- Use the provided script to generate the document file in the appropriate folder.
- Optionally run the metadata extraction script to update the index.
Usage
Run the script with parameters to create a new issue document:
python scripts/create_issue.py --type "Bug" --title "Fix login timeout" --description "Users are logged out after 5 minutes" --severity "High"
See references/templates.md for detailed template structures.
Resources
scripts/
create_issue.py: Script to generate issue documents based on templates.
references/
templates.md: Detailed templates for each issue type.