Issue Writer

Generates structured documentation for bugs, features, RFCs, ADRs, and other development work items.

SkillLearning DocumentationDocs Standards

The source repository doesn't declare a license. Check its terms before reusing the code.

Key features

  • Creates documents in designated project folders (.docs/issues/ or _docs/issues/)
  • Provides predefined templates for different documentation needs
  • Enforces a standardized YAML frontmatter and markdown structure
  • Generates documents for various issue types (Bugs, Features, RFCs, ADRs, etc.)
  • Utilizes a script-based workflow for document creation

Use cases

  • Creating a formal Architectural Decision Record (ADR) to document a key technical choice.
  • Outlining a new feature plan with a consistent structure for team review.
  • Drafting a detailed bug report with standardized fields like severity and status.

FAQ

What capabilities does it provide?

It offers templates for various document types (bugs, features, etc.), enforces a YAML frontmatter and markdown structure, and includes a script to automatically generate new documents in the correct project folder.

What does the Issue Writer skill do?

The Issue Writer skill automates the creation of structured documents for development work items like bugs, features, RFCs (Requests for Comments), and ADRs (Architecture Decision Records).

When should I use this skill?

Use this skill whenever you need to document a software issue, propose a new feature, or record a design decision using a standardized format in your project's designated documentation folder.

How does this skill improve my workflow?

It saves time and ensures consistency by using predefined templates and a script-based workflow. This standardizes how your team documents work items, improving clarity and collaboration.