structural-doc-batch

What problem does it solve?

Software projects often ship with missing structural documentation, violating SOUL.md red lines that require 8 specific documents (PROJECT-OVERVIEW, PRD, ADR, API, TEST-COVERAGE, TECH-DEBT, QA-TRACKER, REGRESSION-GUARD) to exist and be committed to git before merge. This Skill automates the batch generation of all required documents from existing source code, eliminating hours of manual documentation work while ensuring compliance.

Core Features & Use Cases

• Batch Document Generation: Creates all 8 structural documents plus optional retros in a single operation, derived directly from source code, git history, and existing schemas.
• Source-First Derivation: All content is extracted from actual codebase artifacts (routes, Prisma models, test files, commit logs) rather than hallucinated, ensuring accuracy and alignment with reality.
• Git-Safe Workflow: Includes mandatory working tree inspection and precise staging to prevent accidental commits of unrelated changes or data loss from manual file deletions.
• Use Case: When a developer says "I need to補一下文檔" or "This project is missing PROJECT-OVERVIEW and PRD", this Skill generates the complete documentation batch, commits it with a detailed message, and proposes next sprint test actions.

Quick Start

Use the structural-doc-batch skill to analyze your project source code and generate all 8 required structural documents in a single batch operation, then commit them to git with a single commit message.