docs-bug-triage

Classify issue reports as documentation gaps or product bugs.

413|64|Updated Feb 7, 2023
One-click install
npx skills add https://github.com/christianhelle/refitter --skill docs-bug-triage
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-bug-triage
Source: https://github.com/christianhelle/refitter/tree/main/.squad/skills/docs-bug-triage
Command: npx skills add https://github.com/christianhelle/refitter --skill docs-bug-triage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams quickly determine if an issue report points to missing or unclear documentation or to a real product defect.

Core Features & Use Cases

  • Triage criteria: Distinguish explicit promises in docs from implicit product expectations in issue reports.
  • Verdict logging: Record a docs verdict and a communication verdict with supporting evidence.
  • Use Case: When users report inconsistent behavior, decide whether it stems from docs gaps or a bug and route accordingly.

Quick Start

Review an issue report and classify it as docs-related or product-related, then log the verdict

Frequently Asked Questions about docs-bug-triage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I triage issue reports to determine if they are documentation gaps or product bugs?

To triage issue reports for documentation gaps versus product bugs, review the report to distinguish explicit promises in docs from implicit product expectations. Classify the issue as docs-related or product-related, then log a docs verdict and a communication verdict with supporting evidence to route it accordingly.

What is the best way to classify inconsistent user behavior reported in an issue tracker as a docs issue or a bug?

The best way to classify inconsistent user behavior is by applying triage criteria that separate explicit documentation promises from implicit product expectations. This process yields a docs verdict and a communication verdict, backed by gathered evidence, to correctly route the report.

When do I need to use issue triage for documentation quality versus feature behavior?

You need issue triage for documentation quality versus feature behavior when users report inconsistent behavior or unmet expectations. It helps decide whether the inconsistency stems from missing or unclear documentation or a real product defect, ensuring accurate routing across project issue trackers and support channels.

Can I use this triage workflow for support channels as well as project issue trackers?

Yes, you can use this triage workflow for support channels and project issue trackers. It is specifically designed to triage reports about documentation quality, feature behavior, or user expectations by identifying whether an issue points to missing documentation or a real product defect.

How does the verdict logging process work when triaging documentation gaps and product bugs?

The verdict logging process works by recording a docs verdict and a communication verdict with supporting evidence after classifying an issue report. This ensures a consistent triage workflow that captures whether the report indicates a documentation gap or a real product defect for proper routing.

What are the limitations of automated issue triage for distinguishing docs gaps from product bugs?

A limitation of this triage process is the reliance on a consistent workflow requiring evidence gathering to distinguish explicit documentation promises from implicit product expectations. Without clear supporting evidence, accurately classifying whether an issue stems from a docs gap or a product bug becomes difficult.