skills.rest
exception-coder
exception-coderCOMMUNITY
Explore all skills by this author →
GitHub

bug-doc-required

Enforce standardized bug analysis documentation with fixed sections and Mermaid diagrams.

6|1|Updated Mar 30, 2026
Search Tags:#templates#documentation#indexing#mermaid#root-cause#bug-analysis#code-navigation
One-click install
npx skills add https://github.com/exception-coder/team-standards --skill bug-doc-required
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bug-doc-required
Source: https://github.com/exception-coder/team-standards/tree/main/skills/bug-doc-required
Command: npx skills add https://github.com/exception-coder/team-standards --skill bug-doc-required

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill ensures bug reports and analysis documents follow a strict, discoverable structure so investigations are reproducible, affected modules are accurately identified, and root causes are traced without ad-hoc code rescanning.

Core Features & Use Cases

  • Mandatory template enforcement: enforces the fixed chapter order, naming conventions, and directory-per-bug rule under docs/bug/.
  • Context preloading and indexing: instructs loading project overview and related module docs, and requires doc-index-required to read and update INDEX.md.
  • Precise code mapping and diagrams: requires full class names, file paths with verified line numbers, and three Mermaid diagrams (sequence, flow, swimlane) to represent interactions, decisions, and cross-layer calls.
  • Use Case: When a developer reports an NPE, timeout, or functional failure, run this skill to produce a compliance-ready bug analysis that includes reproduction steps, logs, involved classes, key code paths, root cause table, and prioritized fixes.

Quick Start

Invoke the bug-doc-required skill to create a standards-compliant bug analysis for "[brief bug summary]" including reproduction steps, logs, full class names, key code paths, and sequence/flow/swimlane diagrams.

Frequently Asked Questions about bug-doc-required

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

FAQPage Schema
How do I document a root cause analysis for a software bug?▼

Standardized bug analysis documentation requires a fixed section structure with reproduction steps, involved classes, precise file paths with verified line numbers, root cause tables, and three Mermaid diagrams to trace code interactions accurately.

What is the best way to structure bug analysis documentation?▼

The best way to structure bug analysis documentation is by enforcing a fixed chapter order using a directory-per-bug rule under docs/bug/, which ensures investigations remain reproducible and root causes are traceable without ad-hoc code rescanning.

How do I add Mermaid diagrams to bug reports?▼

You add Mermaid diagrams to bug reports by generating sequence, flow, and swimlane diagrams that map interactions, decisions, and cross-layer calls, ensuring the visual representation matches verified code paths and line numbers.

Can I use a fixed template for reporting NPEs and timeout incidents?▼

Yes, you can use a fixed template for reporting NPEs and timeout incidents to produce compliance-ready bug analysis that includes reproduction steps, logs, involved classes, key code paths, and prioritized fixes.

Why does bug documentation require indexing with INDEX.md?▼

Bug documentation requires indexing with INDEX.md to ensure analysis documents follow a strict, discoverable structure, allowing developers to preload project context and accurately identify affected modules without ad-hoc code rescanning.

Related Skills

Explore More Software Engineering Skills→
yulonghe97yulonghe97
8

docs

Update project documentation to reflect completed, verified work.

Community
Intermediate
baobao0303baobao0303
1

harness-index-docs

Generate or update index.md with grouped, alphabetically sorted links to documentation files.

Community
Basic
rysweetrysweet
2

mermaid-diagram-generator

Convert architecture and workflow descriptions into valid Mermaid diagrams.

Community
Intermediate
jagreehaljagreehal
1

awaitly-analyze

Analyze awaitly workflows to generate IRs, Mermaid diagrams, and path statistics.

Community
Advanced