SDD Document Builder
Paste the following prompt into your AI chat to install this skill:
Please install @user_db7ebc1c/sdd-builder according to https://skillhub.cn/install/skillhub.md.
About this skill
Problem
Many codebases lack a trustworthy SDD: entry points are scattered across HTTP, MQ, scheduled jobs, business flows are only known informally, and documentation often reads like unverifiable conclusions without code locations or counter-evidence. sdd-builder turns documentation drafting into a human-driven, evidence-first workflow, where the AI handles retrieval, synthesis, claims, and validation, while humans confirm the key decisions.
How It Works
Core capability: it links project knowledge, business context, code evidence, SDD drafts, and validation reports into a pausable stage flow:
- Pre-knowledge base: scans rules/, architecture/, and domain-knowledge/, then outputs coding conventions, architectural relationships, and domain concepts with code locations attached.
- Stages one through five: collects business inputs and images, explores the codebase, and builds ENTRY-* and FLOW-* claim pools; it then drafts README.md and automatically validates evidence and claims.
- Final output: removes claim material, keeps an evidence-backed document, and supports human correction plus optional refinement into README.purified.md.
Boundary: it suits repositories that need structured technical documentation and may require iterative refinement. If business context is missing, code evidence is weak, or the expectation is a fully accurate one-shot document, humans still need to supply and verify key inputs.
Use Cases
- When taking over an old Java service, map HTTP, MQ, and scheduled entry points into a verifiable SDD.
- When architecture notes and domain terms are missing, generate rules, architecture, and domain-knowledge from code.
- After drafting an SDD, verify that each business claim has code evidence and remove claims from the final document.
- After repeated reviews, refine a confirmed document into README.purified.md.
Best For
- Backend engineers maintaining microservices: need to consolidate scattered entry points and call chains into handoff-ready docs.
- Architects taking over legacy systems: need to reconstruct architecture, domain knowledge, and conventions from code evidence.
- Delivery engineers: need to verify SDD claims and produce a final document without assertion artifacts.
- Engineers documenting business flows: need to turn multi-round business notes into structured docs and image inventories.
Related Skills
Automatically indexes Gradle-cached AAR/JAR dependency classes and returns library coordinates, versions, and public APIs by fully qualified name, using only the Python standard library.
Codifies AMT and YourMT3 training conventions, script patterns, hyperparameters, precision, checkpoints, and NaN safeguards.
Retrieve relevant chunks from a customer-managed PKM dataset by dataset_id and return concise, source-annotated answers.
Convert PRDs, user stories, or functional specs into prioritized test-point checklists covering functional, business-rule, boundary, exception, and non-functional dimensions.