bug-doc-required
CommunityEnforce structured bug analysis with mandatory diagrams
Software Engineering#templates#documentation#indexing#mermaid#root-cause#bug-analysis#code-navigation
Authorexception-coder
Version1.0.0
Installs0
System Documentation
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.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: bug-doc-required Download link: https://github.com/exception-coder/team-standards/archive/main.zip#bug-doc-required Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.