debug-doc-writer

Generate dated bug-fix entries and update the debug/README.md index.

2|Updated Feb 7, 2026
One-click install
npx skills add https://github.com/Showiix/EsportManager2 --skill debug-doc-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: debug-doc-writer
Source: https://github.com/Showiix/EsportManager2/tree/main/.claude/skills/debug-doc-writer
Command: npx skills add https://github.com/Showiix/EsportManager2 --skill debug-doc-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

记录每次修复的要点到 debug/ 目录,方便团队追溯与审计。

Core Features & Use Cases

  • 记录修复要点到 debug/ 目录,形成可检索的变更日志。
  • 自动更新 debug/README.md 的索引,提升检索效率。
  • 将修复信息与提交信息、日期等元数据绑定,便于 QA 审核。

Quick Start

After fixing a bug, run this skill to create a dated, indexed entry in the debug/ directory.

Frequently Asked Questions about debug-doc-writer

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

FAQPage Schema
How do I generate traceable bug-fix logs from commit messages and diffs?

To generate traceable bug-fix logs, record your resolved issue details to the debug directory. This process uses commit messages and diffs to create structured, date-stamped entries for team audits.

What is the best way to maintain a change log index for QA audits?

Maintaining a change log index for QA audits requires updating the debug/README.md file. This index tracks all fixes automatically, improving retrieval efficiency and ensuring structured traceability for quality assurance.

How do I document resolved software bugs with date-stamped entries?

Document resolved software bugs by creating date-stamped entries in the debug directory. This binds the fix information with metadata like commit messages, providing structured notes for later review.

Does this bug-fix documentation approach work for software development workflows requiring traceability?

Yes, this bug-fix documentation approach works for software development workflows requiring traceability. It records fix details to a debug directory and updates a README index to satisfy QA audit requirements.

When do I need to record fix entries in a debug directory?

You need to record fix entries in a debug directory after resolving a software issue. This creates a searchable change log of fix points that binds metadata like dates and commit messages for team traceability.

Why record bug-fix documentation to a debug directory instead of standard commit logs?

Recording bug-fix documentation to a debug directory separates traceable change logs from standard commits. This provides a dedicated, indexed, and date-stamped history specifically for QA audits and team retrospectives.