eliteforge-tech-doc

Original：🇨🇳 Chinese

Translated

1 scriptsChecked / no sensitive code detected

General Technical Design Document Summarization Skill: Scan documents and diagrams in the current execution directory (Markdown, PlantUML/Mermaid, drawio, images, etc.), extract system objectives, module boundaries, core processes, sequences and states, and output structured technical design documents. Use this skill when users mention "technical design documents", "solution sorting", "summarize design based on existing documents", "summarize documents and diagrams in the directory", or "complete sequence diagrams/state diagrams".

2installs

Sourcecloudsen/eliteforge-skills

Added on2026-03-24

NPX Install

npx skill4agent add cloudsen/eliteforge-skills eliteforge-tech-doc

SKILL.md Content (Chinese)

View Translation Comparison →

EliteForge Tech Doc

Objectives

Generate reviewable technical design documents based on existing materials, without fabricating facts out of thin air.
Cover all documents and diagrams in the current execution directory: at least include a source list and give disposal conclusions (Adopted/Background Reference/To Be Confirmed).
Prioritize reusing existing terminology, process names, and diagram styles in the repository.

Execution Sequence (Follow Every Time)

Run
```
scripts/list_doc_and_diagram_sources.sh .
```
in the current execution directory to inventory materials.
Create a "Source List" and read materials by priority:
- P0: Core documents in
```
README*
```
  ,
```
*design*
```
  ,
```
*architecture*
```
  ,
```
*spec*
```
  ,
```
docs/**
```
  .
- P1: Documents related to interfaces, data models, deployment, operation and maintenance, and fault handling.
- P2: Long-tail explanatory documents and image resources (write at least one-line summary, no omissions).

Create a Fact Table (suggested fields:

Conclusion

,

Evidence File

,

Confidence Level

,

Remarks

).

First read references/tech-doc-template.md, then draft the target document according to the template.
Prioritize reusing existing diagrams:
- When
```
.mmd/.mermaid/.puml/.plantuml/.drawio
```
  files exist, prioritize referencing or rewriting them into diagram blocks with equivalent semantics.
- Only when image files (
```
.png/.jpg/.jpeg/.webp
```
  ) exist, summarize based on surrounding documents and file names, and mark uncertain items as "To Be Confirmed Manually".
Output the document to the path specified by the user; if no path is specified, write to the default path
```
./tech-design-summary.md
```
in the current directory.
Conduct a final check according to references/quality-checklist.md before replying with the result.

Mandatory Constraints

Forbid inventing components, interfaces, processes, states, or sequence relationships.
Each key conclusion must be bound to at least one source file path.
When conflicting information is found, explicitly list the conflict points and basis for trade-offs.
Do not ignore any documents/diagram files in the scan results; must state the reason for files that cannot be processed.
The output document must include "Source List" and "Items To Be Confirmed".

Diagram and Process Extraction Rules

For process-related content, prioritize outputting "scenario-based structure": trigger conditions, inputs, steps, outputs, and exception branches.
For call chain content, prioritize using
```
mermaid
```
```
sequenceDiagram
```
to express key participants and call directions.
For state transition content, prioritize using
```
mermaid
```
```
stateDiagram-v2
```
to express states and transition conditions.
For pseudo-code, retain domain action names and do not replace them with vague descriptions.
For diagrams with unclear meanings, retain the original file path and mark it as "To Be Confirmed Manually"; do not guess details.

Minimum Structure of Output Document

Output according to the template, including at least the following sections:

Document Source List
Background and Objectives
Terminology and Boundaries
Architecture Overview
Core Scenario Processes (may include pseudo-code)
Sequence Diagram
State Diagram
Key Points of Data and Interfaces
Risks and Items To Be Confirmed

Prioritize the organization method of "Interactive Overview -> Scenario-based Process (Pseudo-code) -> Sequence Diagram -> State Diagram" to facilitate tracing from business actions to system implementation.

Output Style

Default output in Chinese, retain original terms for key nouns (such as module names, interface names, class names).
Use short paragraphs, avoid vague and empty statements.
Only retain content valuable for review decisions in diagrams and pseudo-code; avoid lengthy repetitions.

Reference File Reading Strategy

Read references/tech-doc-template.md first during the first execution.
Read references/quality-checklist.md for final check before delivering the draft.

Quick Commands

bash

# 1) Inventory documents and diagrams in the current directory
skills/eliteforge-tech-doc/scripts/list_doc_and_diagram_sources.sh .

# 2) Generate technical design document (file name can be modified)
# Output example: ./tech-design-summary.md

Example Trigger Phrases

"Please scan all documents and diagrams in the current directory and produce a technical design document."
"Based on the Markdown files and sequence diagrams in the repository, organize a solution design draft."
"Summarize the existing design materials into a reviewable tech design and mark missing information."

Reference Files

Technical Design Document Template
Quality Self-Check Checklist