documenting-bugs

Create structured bug reports with reproduction steps, severity, and root cause analysis.

2|Updated Jan 10, 2026
One-click install
npx skills add https://github.com/lwndev/lwndev-agent-skills --skill documenting-bugs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documenting-bugs
Source: https://github.com/lwndev/lwndev-agent-skills/tree/main/src/skills/documenting-bugs
Command: npx skills add https://github.com/lwndev/lwndev-agent-skills --skill documenting-bugs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) and references (resource) components.

What problem does it solve?

This Skill standardizes the process of documenting software defects, ensuring that each bug report includes essential details like root cause analysis and traceable acceptance criteria, facilitating efficient debugging and resolution.

Core Features & Use Cases

  • Structured Bug Reports: Creates comprehensive documents for bugs, including reproduction steps, expected vs. actual behavior, and severity.
  • Root Cause Analysis: Guides the user to investigate and document the underlying causes of defects.
  • Traceable Acceptance Criteria: Ensures that fixes are directly linked back to the identified root causes.
  • Use Case: When a user reports that the application crashes intermittently during checkout, this Skill helps them create a detailed bug report, including steps to reproduce, potential root causes identified through investigation, and specific criteria to verify the fix.

Quick Start

Use the documenting-bugs skill to create a new bug report for a critical runtime error.

Frequently Asked Questions about documenting-bugs

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

FAQPage Schema
How do I write a bug report with root cause analysis?

To write a bug report with root cause analysis, use a structured template capturing reproduction steps, expected versus actual behavior, and traceable acceptance criteria to standardize defect tracking and resolution.

What should be included in software defect documentation?

Software defect documentation should include detailed reproduction steps, severity levels, expected versus actual behavior, root cause analysis findings, and traceable acceptance criteria to verify the fix.

How do I create traceable acceptance criteria for bug fixes?

Create traceable acceptance criteria for bug fixes by linking verification conditions directly back to the identified root cause and expected behavior within the standardized bug report.

What is the best way to standardize bug tracking across a development team?

Standardize bug tracking across a development team by enforcing predefined templates and categorization rules for defect reporting, ensuring consistent documentation of root causes and severity.

Why do I need to document root cause analysis for intermittent application crashes?

Documenting root cause analysis for intermittent application crashes ensures the underlying defect is systematically investigated, preventing recurrence by linking targeted fixes to traceable acceptance criteria.