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.

majiayu000 Updated 567 repo stars

File contents

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

  1. Determine the type of document needed (Bug, Feature Plan, RFC, ADR, Task, Retrospective).
  2. Gather required information (title, description, status, etc.).
  3. Use the provided script to generate the document file in the appropriate folder.
  4. 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.

majiayu000/claude-skill-registry-data/tree/main/development/issue-writer commit 0a0f2642ef

Frequently asked questions

npx skillmds@latest add majiayu000/issue-writer