fireworks-tech-graph · diff
git:20260722.0795e89 to git:20260908.e5d0895
76 added, 473 removed. Audit A to A.
---
name: fireworks-tech-graph
description: >-
- Create technical diagrams such as software architecture, data flow,
- flowcharts, sequence diagrams, C4 reviews, cloud deployments, event streams,
- observability investigations, agent/memory systems, UML, ER, network
- topology, timelines, and technical concept maps, then export SVG, PNG,
- focused semantic SVG-to-GIF motion, or offline interactive HTML. Treat direct
- requests such as "Generate a GIF", "生成 GIF", or "制作 GIF" as motion requests,
- and use this skill when the user asks to visualize a system or engineering
- concept. Do not use for photos, raster artwork, or quantitative data charts.
+ Create precise SVG technical diagrams, export PNG or offline HTML, and animate
+ supported semantic SVGs to GIF. Use for architecture, UML, agent, cloud or
+ workflow diagrams; not photos, raster art or statistical charts.
---
# Fireworks Tech Graph
- Generate geometry-checked SVG technical diagrams, high-resolution PNG, validated SVG-to-GIF semantic motion, and sanitized offline interactive HTML.
-
- ## Runtime Compatibility
-
- Use this repository unchanged in both Codex and Claude Code. It follows the Agent Skills layout: `SKILL.md` is the shared entry point, bundled resources use relative paths, and `agents/openai.yaml` adds optional Codex UI metadata without affecting Claude Code.
-
- Before reading a reference or running a script, resolve the directory containing this `SKILL.md` as `SKILL_ROOT`. Do not assume the current working directory is the skill directory, and do not assume a variable set in one shell call persists into the next.
-
- - In Claude Code, use `${CLAUDE_SKILL_DIR}`.
- - In Codex, use the absolute skill directory shown in the loaded skill metadata.
-
- Every command block below sets `SKILL_ROOT` itself. In Codex, replace `/absolute/path/from-codex-skill-metadata` with the absolute skill directory before running the command.
-
- ## Helper Scripts (Recommended)
-
- The unified `scripts/fireworks.py` CLI and compatibility helpers provide stable rendering, geometry validation, inspection, animation, and export:
+ One portable Agent Skill for Codex and Claude Code. SVG is the canonical artifact;
+ PNG, offline HTML and supported GIF motion are output routes. Preserve requested
+ labels, topology and meaning; a successful command is not a visual quality verdict.
- ### 1. `generate-diagram.sh` - Validate SVG + export PNG
- ```bash
- SKILL_ROOT="${CLAUDE_SKILL_DIR:-/absolute/path/from-codex-skill-metadata}"
- "$SKILL_ROOT/scripts/generate-diagram.sh" -t architecture -s 1 -o ./output/arch.svg
- ```
- - Validates an existing SVG file
- - Exports PNG after validation
- - Example: `"$SKILL_ROOT/scripts/generate-diagram.sh" -t architecture -s 1 -o ./output/arch.svg`
+ ## Locate and select
- ### 2. `generate-from-template.py` - Create starter SVG from template
- ```bash
- SKILL_ROOT="${CLAUDE_SKILL_DIR:-/absolute/path/from-codex-skill-metadata}"
- mkdir -p ./output
- python3 "$SKILL_ROOT/scripts/generate-from-template.py" architecture ./output/arch.svg '{"title":"My Diagram","nodes":[],"arrows":[]}'
- ```
- - Loads a built-in SVG template
- - Renders nodes, arrows, and legend entries from JSON input
- - Escapes text content to keep output XML-valid
+ Resolve the directory containing this file as `SKILL_ROOT`. Use
+ `${CLAUDE_SKILL_DIR}` in Claude Code or the absolute directory in Codex's loaded
+ skill metadata. Do not assume cwd or a previous shell variable persists.
- ### 3. `validate-svg.sh` - Validate SVG syntax
- ```bash
- SKILL_ROOT="${CLAUDE_SKILL_DIR:-/absolute/path/from-codex-skill-metadata}"
- "$SKILL_ROOT/scripts/validate-svg.sh" <svg-file>
- ```
- - Checks XML syntax
- - Verifies tag balance
- - Validates marker references
- - Checks attribute completeness
- - Validates path data
+ Use the installed version for the task. Run `version` for source/version questions
+ and `doctor` when diagnosing a missing renderer, font or dependency; do not make
+ installation, updates or a complete test suite prerequisites for every diagram.
- ### 4. `test-all-styles.sh` - Batch test all styles
```bash
SKILL_ROOT="${CLAUDE_SKILL_DIR:-/absolute/path/from-codex-skill-metadata}"
- "$SKILL_ROOT/scripts/test-all-styles.sh"
- ```
- - Tests multiple diagram sizes
- - Validates all generated SVGs
- - Generates test report
-
- **When to use scripts:**
- - Use scripts when generating complex SVGs to avoid syntax errors
- - Scripts provide automatic validation and error reporting
- - Recommended for production diagrams
-
- ## Workflow (Always Follow This Order)
-
- 1. **Classify** the diagram type (see Diagram Types below)
- 2. **Extract structure** — identify layers, nodes, edges, flows, and semantic groups from user description
- 3. **Plan layout** — load `$SKILL_ROOT/references/composition-quality-contract.md`, then apply the diagram-type layout rules; for Obsidian/Vault or `_teach` HTML output, also load `$SKILL_ROOT/references/obsidian-vault.md`
- 4. **Load style reference** — always load `$SKILL_ROOT/references/style-1-flat-icon.md` unless user specifies another; load the matching `$SKILL_ROOT/references/style-N-*.md` for exact color tokens and SVG patterns
- 5. **Select semantic contract** — Styles 9–12 default to `c4-review`, `cloud-fabric`, `event-transit`, and `ops-pulse`; use `scripts/fireworks.py validate` before layout so missing or contradictory engineering facts fail closed
- 6. **Map nodes to shapes** — use Shape Vocabulary below
- 7. **Check icon needs** — load `$SKILL_ROOT/references/icons.md` for known products
- 8. **Write SVG** with adaptive strategy (see SVG Generation Strategy below)
- 9. **Validate**: Run `"$SKILL_ROOT/scripts/validate-svg.sh" file.svg` to check XML, markers, geometry, composition budgets, and renderability
- 10. **Export PNG**: Use `cairosvg` (recommended). Load `$SKILL_ROOT/references/png-export.md` when choosing another renderer
- 11. **Animate on request** — `让这张图动起来` / `生成 GIF` / `制作 GIF` / `Animate this diagram` / `Generate a GIF` means the latest generated semantic SVG to one GIF with `auto`, 5.75s, 20fps, and 960px width when that SVG satisfies one of the 12 approved motion contracts. Exact source bytes are not pinned, but role/stage/order coverage, route directions, required colors, and geometry fail closed; do not claim arbitrary same-style topologies are supported. Load `$SKILL_ROOT/references/motion-effects.md`, run `fireworks.py animate`, and report SVG/GIF/report paths. GIF is the only motion media format, while the default command also emits `<output>.motion.json`. Styles 1–12 are enabled, and their contracts plus the shared `+2s-settled-flow` timing revision are user-approved; the default keeps frames 38–109 at full opacity and resets on frames 110–114. Every scene begins connector-free and advances its moving primitives toward each target. The 75-vs-115 compatibility gate counts binary-exact frames first, decoded-RGBA-exact frames second, and permits a guarded antialias equivalent only when AE ≤ 128, normalized RMSE ≤ 0.001, every difference component is at most 2px wide or high, and all differences remain on edge or node borders; DOM and signature geometry stay strict-exact. Reject raster animation inputs and non-GIF motion outputs. Explicit 3.75s/75-frame and 2.75s/55-frame timelines remain supported
- 12. **Visual review gate** — if your runtime can read images, load the exported PNG back and inspect it. Syntactic validity does not guarantee visual correctness: arrows may cross through component interiors, labels may collide with lifelines or other labels, boxes may overlap, alt-frame text may sit on top of a message, or a legend may cover content. Run this QA with a non-interactive renderer and the available local image-inspection tool; do not navigate, claim, or reuse the user's active browser tab. If you see any of these, revise the SVG and re-export, with at most two focused correction passes. Common fixes:
- - Route arrows through gaps between boxes, not through box interiors
- - Move arrow labels 6-8px away from the arrow line (offset-first); add background rects only when offset is insufficient
- - Widen inter-row/inter-column gutters so same-layer arrows have clear corridors
- - Collapse repeated cross-layer arrows into a single "delegates down" rail outside the content area
- - Move legend/notes out of any region where arrows or labels land
- - Increase viewBox height/width rather than packing elements tighter
- - If a filtered element (drop-shadow, blur) is missing one side of its border, move it ≥30px away from that viewBox edge, or remove the filter and rely on color/contrast for visual separation
- Report `visual_review: passed` after inspection. If image reading is unavailable, report `visual_review: skipped (image reader unavailable)` — do not guess or claim visual correctness.
-
- ## Rule Precedence
-
- Use this order when instructions disagree:
-
- 1. The user's explicit content and style request
- 2. The selected `$SKILL_ROOT/references/style-N-*.md` visual tokens (palette, typography, corner radius, shadow treatment)
- 3. Diagram-type layout rules and semantic flow requirements in this file
- 4. Universal defaults and examples
-
- Geometry and validation gates always remain active: style guidance cannot justify unreadable text, missing marker definitions, or arrows crossing component interiors. Tables in this file define semantic defaults; a selected style may override their colors and stroke treatment while preserving the meaning and direction of each flow.
-
- ## Diagram Types & Layout Rules
-
- ### Architecture Diagram
- Nodes = services/components. Group into **horizontal layers** (top→bottom or left→right).
- - Typical layers: Client → Gateway/LB → Services → Data/Storage
- - Use `<rect>` dashed containers to group related services in the same layer
- - Arrow direction follows data/request flow
- - ViewBox: `0 0 960 600` standard, `0 0 960 800` for tall stacks
-
- ### Data Flow Diagram
- Emphasizes **what data moves where**. Focus on data transformation.
- - Label every arrow with the data type (e.g., "embeddings", "query", "context")
- - Use wider arrows (`stroke-width: 2.5`) for primary data paths
- - Dashed arrows for control/trigger flows
- - Color arrows by data category (not just Agent/RAG — use semantics)
-
- ### Flowchart / Process Flow
- Sequential decision/process steps.
- - Top-to-bottom preferred; left-to-right for wide flows
- - Diamond shapes for decisions, rounded rects for processes, parallelograms for I/O
- - Keep node labels short (≤3 words); put detail in sub-labels
- - Align nodes on a grid: x positions snap to 120px intervals, y to 80px
-
- ### Agent Architecture Diagram
- Shows how an AI agent reasons, uses tools, and manages memory.
- Key conceptual layers to always consider:
- - **Input layer**: User, query, trigger
- - **Agent core**: LLM, reasoning loop, planner
- - **Memory layer**: Short-term (context window), Long-term (vector/graph DB), Episodic
- - **Tool layer**: Tool calls, APIs, search, code execution
- - **Output layer**: Response, action, side-effects
- Use cyclic arrows (loop arcs) to show iterative reasoning. Separate memory types visually.
-
- ### Memory Architecture Diagram (Mem0, MemGPT-style)
- Specialized agent diagram focused on memory operations.
- - Show memory **write path** and **read path** separately (different arrow colors)
- - Memory tiers: Working Memory → Short-term → Long-term → External Store
- - Label memory operations: `store()`, `retrieve()`, `forget()`, `consolidate()`
- - Use stacked rects or layered cylinders for storage tiers
-
- ### Sequence Diagram
- Time-ordered message exchanges between participants.
- - Participants as vertical **lifelines** (top labels + vertical dashed lines)
- - Messages as horizontal arrows between lifelines, top-to-bottom time order
- - Activation boxes (thin filled rects on lifeline) show active processing
- - Group with `<rect>` loop/alt frames with label in top-left corner
- - ViewBox height = 80 + (num_messages × 50)
-
- ### Comparison / Feature Matrix
- Side-by-side comparison of approaches, systems, or components.
- - Column headers = systems, row headers = attributes
- - Row height: 40px; column width: min 120px; header row height: 50px
- - Checked cell: tinted background (e.g. `#dcfce7`) + `✓` checkmark; unsupported: `#f9fafb` fill
- - Alternating row fills (`#f9fafb` / `#ffffff`) for readability
- - Max readable columns: 5; beyond that, split into two diagrams
-
- ### Timeline / Gantt
- Horizontal time axis showing durations, phases, and milestones.
- - X-axis = time (weeks/months/quarters); Y-axis = items/tasks/phases
- - Bars: rounded rects, colored by category, labeled inside or beside
- - Milestone markers: diamond or filled circle at specific x position with label above
- - ViewBox: `0 0 960 400` typical; wider for many time periods: `0 0 1200 400`
-
- ### Mind Map / Concept Map
- Radial layout from central concept.
- - Central node at `cx=480, cy=280`
- - First-level branches: evenly distributed around center (360/N degrees)
- - Second-level branches: branch off first-level at 30-45° offset
- - Use curved `<path>` with cubic bezier for branches, not straight lines
-
- ### Class Diagram (UML)
- Static structure showing classes, attributes, methods, and relationships.
- - **Class box**: 3-compartment rect (name / attributes / methods), min width 160px
- - Top compartment: class name, bold, centered (abstract = *italic*)
- - Middle: attributes with visibility (`+` public, `-` private, `#` protected)
- - Bottom: method signatures, same visibility notation
- - **Relationships**:
- - Inheritance (extends): solid line + hollow triangle arrowhead, child → parent
- - Implementation (interface): dashed line + hollow triangle, class → interface
- - Association: solid line + open arrowhead, label with multiplicity (1, 0..*, 1..*)
- - Aggregation: solid line + hollow diamond on container side
- - Composition: solid line + filled diamond on container side
- - Dependency: dashed line + open arrowhead
- - **Interface**: `<<interface>>` stereotype above name, or circle/lollipop notation
- - **Enum**: compartment rect with `<<enumeration>>` stereotype, values in bottom
- - Layout: parent classes top, children below; interfaces to the left/right of implementors
- - ViewBox: `0 0 960 600` standard; `0 0 960 800` for deep hierarchies
-
- ### Use Case Diagram (UML)
- System functionality from user perspective.
- - **Actor**: stick figure (circle head + body line) placed outside system boundary
- - Label below figure, 13-14px
- - Primary actors on left, secondary/supporting on right
- - **Use case**: ellipse with label centered inside, min 140×60px
- - Keep names verb phrases: "Create Order", "Process Payment"
- - **System boundary**: large rect with dashed border + system name in top-left
- - **Relationships**:
- - Include: dashed arrow `<<include>>` from base to included use case
- - Extend: dashed arrow `<<extend>>` from extension to base use case
- - Generalization: solid line + hollow triangle (specialized → general)
- - Layout: system boundary centered, actors outside, use cases inside
- - ViewBox: `0 0 960 600` standard
-
- ### State Machine Diagram (UML)
- Lifecycle states and transitions of an entity.
- - **State**: rounded rect with state name, min 120×50px
- - Internal activities: small text `entry/ action`, `exit/ action`, `do/ activity`
- - **Initial state**: filled black circle (r=8), one outgoing arrow
- - **Final state**: filled circle (r=8) inside hollow circle (r=12)
- - **Choice**: small hollow diamond, guard labels on outgoing arrows `[condition]`
- - **Transition**: arrow with optional label `event [guard] / action`
- - Guard conditions in square brackets
- - Actions after `/`
- - **Composite/nested state**: larger rect containing sub-states, with name tab
- - **Fork/join**: thick horizontal or vertical black bar (synchronization)
- - Layout: initial state top-left, final state bottom-right, flow top-to-bottom
- - ViewBox: `0 0 960 600` standard
-
- ### ER Diagram (Entity-Relationship)
- Database schema and data relationships.
- - **Entity**: rect with entity name in header (bold), attributes below
- - Primary key attribute: underlined
- - Foreign key: italic or marked with (FK)
- - Min width: 160px; attribute font-size: 12px
- - **Relationship**: diamond shape on connecting line
- - Label inside diamond: "has", "belongs to", "enrolls in"
- - Cardinality labels near entity: `1`, `N`, `0..1`, `0..*`, `1..*`
- - **Weak entity**: double-bordered rect with double diamond relationship
- - **Associative entity**: diamond + rect hybrid (rect with diamond inside)
- - Line style: solid for identifying relationships, dashed for non-identifying
- - Layout: entities in 2-3 rows, relationships between related entities
- - ViewBox: `0 0 960 600` standard; wider `0 0 1200 600` for many entities
-
- ### Network Topology
- Physical or logical network infrastructure.
- - **Devices**: icon-like rects or rounded rects
- - Router: circle with cross arrows
- - Switch: rect with arrow grid
- - Server: stacked rect (rack icon)
- - Firewall: brick-pattern rect or shield shape
- - Load Balancer: horizontal split rect with arrows
- - Cloud: cloud path (overlapping arcs)
- - **Connections**: lines between device centers
- - Ethernet/wired: solid line, label bandwidth
- - Wireless: dashed line with WiFi symbol
- - VPN: dashed line with lock icon
- - **Subnets/Zones**: dashed rect containers with zone label (DMZ, Internal, External)
- - **Labels**: device hostname + IP below, 12-13px
- - Layout: tiered top-to-bottom (Internet → Edge → Core → Access → Endpoints)
- - ViewBox: `0 0 960 600` standard
-
- ## UML Coverage Map
-
- Full mapping of UML 14 diagram types to supported diagram types:
-
- | UML Diagram | Supported As | Notes |
- |-------------|-------------|-------|
- | Class | Class Diagram | Full UML notation |
- | Component | Architecture Diagram | Use colored fills per component type |
- | Deployment | Architecture Diagram | Add node/instance labels |
- | Package | Architecture Diagram | Use dashed grouping containers |
- | Composite Structure | Architecture Diagram | Nested rects within components |
- | Object | Class Diagram | Instance boxes with underlined name |
- | Use Case | Use Case Diagram | Full actor/ellipse/relationship |
- | Activity | Flowchart / Process Flow | Add fork/join bars |
- | State Machine | State Machine Diagram | Full UML notation |
- | Sequence | Sequence Diagram | Add alt/opt/loop frames |
- | Communication | — | Approximate with Sequence (swap axes) |
- | Timing | Timeline | Adapt time axis |
- | Interaction Overview | Flowchart | Combine activity + sequence fragments |
- | ER Diagram | ER Diagram | Chen/Crow's foot notation |
-
- ## Shape Vocabulary
-
- Map semantic concepts to consistent shapes across all diagram types:
-
- | Concept | Shape | Notes |
- |---------|-------|-------|
- | User / Human | Circle + body path | Stick figure or avatar |
- | LLM / Model | Rounded rect with brain/spark icon or gradient fill | Use accent color |
- | Agent / Orchestrator | Hexagon or rounded rect with double border | Signals "active controller" |
- | Memory (short-term) | Rounded rect, dashed border | Ephemeral = dashed |
- | Memory (long-term) | Cylinder (database shape) | Persistent = solid cylinder |
- | Vector Store | Cylinder with grid lines inside | Add 3 horizontal lines |
- | Graph DB | Circle cluster (3 overlapping circles) | |
- | Tool / Function | Gear-like rect or rect with wrench icon | |
- | API / Gateway | Hexagon (single border) | |
- | Queue / Stream | Horizontal tube (pipe shape) | |
- | File / Document | Folded-corner rect | |
- | Browser / UI | Rect with 3-dot titlebar | |
- | Decision | Diamond | Flowcharts only |
- | Process / Step | Rounded rect | Standard box |
- | External Service | Rect with cloud icon or dashed border | |
- | Data / Artifact | Parallelogram | I/O in flowcharts |
-
- ## Arrow Semantics
-
- Always assign arrow meaning, not just color. The values below are defaults; the selected style reference overrides colors and stroke weights while preserving flow semantics:
-
- | Flow Type | Color | Stroke | Dash | Meaning |
- |-----------|-------|--------|------|---------|
- | Primary data flow | blue `#2563eb` | 2px solid | none | Main request/response path |
- | Control / trigger | orange `#ea580c` | 1.5px solid | none | One system triggering another |
- | Memory read | green `#059669` | 1.5px solid | none | Retrieval from store |
- | Memory write | green `#059669` | 1.5px | `5,3` | Write/store operation |
- | Async / event | gray `#6b7280` | 1.5px | `4,2` | Non-blocking, event-driven |
- | Embedding / transform | purple `#7c3aed` | 1px solid | none | Data transformation |
- | Feedback / loop | purple `#7c3aed` | 1.5px curved | none | Iterative reasoning loop |
-
- Always include a **legend** when 2+ arrow types are used.
-
- ## Layout Rules & Validation
-
- **Spacing**:
- - Same-layer nodes: 80px horizontal, 120px vertical between layers
- - Canvas margins: 40px minimum, 60px between node edges
- - Snap to 8px grid: horizontal 120px intervals, vertical 120px intervals
-
- **Arrow Labels** (CRITICAL):
- - **Offset-first** (default): place label 6-8px above horizontal arrows, or 8px left/right of vertical arrows — do not overlap the arrow line
- - **Background fallback**: add `<rect fill="canvas_bg" opacity="0.95"/>` only when the offset label still crosses another visual element (another arrow, a node edge, etc.)
- - Place mid-arrow, ≤3 words, stagger by 15-20px when multiple arrows converge
- - Maintain 10px safety distance from nodes
-
- **Arrow Routing**:
- - Prefer orthogonal (L-shaped) paths to minimize crossings
- - Anchor arrows on component edges, not geometric centers
- - Route around dense node clusters, use different y-offsets for parallel arrows
- - Jump-over arcs (5px radius) for unavoidable crossings
- - Compress equivalent bidirectional traffic only when both directions share the same semantics and styling: use one corridor with `marker-start` + `marker-end`, or two visibly offset paths in that corridor
- - Keep read/write, request/response, sync/async, or differently labeled directions as separate arrows; remove redundant bends and duplicate rails without erasing direction or meaning
-
- **Post-Generation Arrow Optimization**:
-
- When a user asks to "优化箭头" / "fix arrow routing" / "optimize the diagram" on an already-generated diagram, preserve all nodes, containers, styles, and layout — only modify the `arrows` entries in the JSON data, then re-render with `generate-from-template.py`.
-
- Available arrow override fields (in recommended order of use):
-
- | Field | Type | When to Use |
- |-------|------|-------------|
- | `source_port` / `target_port` | `"left"` / `"right"` / `"top"` / `"bottom"` | Arrow exits/enters from the wrong edge |
- | `corridor_x` | `[x, ...]` | Hint vertical segments toward this x lane (soft preference) |
- | `corridor_y` | `[y, ...]` | Hint horizontal segments toward this y lane (soft preference) |
- | `route_points` | `[[x1,y1], [x2,y2], ...]` | Exact ordered waypoints; each leg is routed orthogonally and unsafe points are rejected |
- | `routing_padding` | number (default: 24) | *(Advanced)* Adjust obstacle clearance for this arrow |
- | `port_clearance` | number | *(Advanced)* Adjust first-segment offset from node edge |
- | `label_style` | `"badge"` / `"offset"` | Choose `"offset"` when badge backgrounds create visual clutter; keep `"badge"` (default) for legacy/high-contrast labels |
-
- For JSON/template rendering, the default remains `"badge"` for backward compatibility. Set `"label_style": "offset"` on individual arrows when you want offset-first labels without background rects.
-
- Optimization steps:
- 1. Read the existing SVG — identify which arrows overlap, cross nodes, or look misaligned
- 2. Find those arrows in the JSON data by `source` / `target` pair
- 3. Add `source_port` / `target_port` if the exit/entry direction is wrong; add `corridor_x` / `corridor_y` to space parallel arrows apart; use `route_points` only when hints alone cannot resolve the path
- 4. Re-run `generate-from-template.py` with the updated JSON and validate with `validate-svg.sh`
-
- Example — spacing two overlapping arrows into separate corridors:
- ```json
- { "source": "nodeA", "target": "nodeB", "corridor_y": [280] }
- { "source": "nodeC", "target": "nodeD", "corridor_y": [320] }
- ```
-
- **Line Overlap Prevention** (CRITICAL - common in AI-generated diagrams):
- When two arrows must cross each other, ALWAYS use jump-over arcs to prevent visual overlap:
- - Crossing horizontal arrows: add a small semicircle arc (radius 5px, stroke same color as arrow, fill none) that "jumps over" the other line
- - SVG pattern for jump-over: use a white/matching-background arc on the lower layer, then draw the upper arc on top
- - Multiple crossings: stagger arc radii (5px, 7px, 9px) so arcs don't overlap each other
- - Never let two arrows' straight-line segments cross without a jump-over arc
-
- **Validation Checklist** (run before finalizing):
- 1. **Arrow-Component Collision**: Arrows MUST NOT pass through component interiors (route around with orthogonal paths)
- 2. **Text Overflow**: All text MUST fit with 8px padding (estimate: `text.length × 7px ≤ shape_width - 16px`)
- 3. **Arrow-Text Alignment**: Arrow endpoints MUST connect to shape edges (not floating); arrow labels should not overlap arrow lines (use offset positioning or background rects)
- 4. **Container Discipline**: Prefer arrows entering and leaving section containers through open gaps between components, not through inner component bodies
- 5. **Filter Boundary Safety**: For every element with `filter="url(...)"`, verify `(element_x + element_width + filter_extension) ≤ viewBox_width` AND `element_x ≥ filter_extension`. The default filter region extends 10-20% beyond bbox; staying near viewBox edges causes Chrome/cairosvg to clip the element's edge-side stroke (one side of the border vanishes while other sides render correctly)
- 6. **Arrow-Title Collision**: Arrows MUST NOT cross through section/container title text or region labels (font-size ≥ 13px). For smaller annotations (< 13px), prefer routing around but tolerate if layout constraints require it. *(Visual self-review check — not covered by `validate-svg.sh` automated checks)*
- 7. **Frame Label–Arrow Alignment** (sequence diagrams): Section/frame label badges MUST be vertically centered with their first message arrow. Compute `badge_y = first_arrow_y - (badge_height / 2)`. When appending new sections to an existing diagram, verify alignment matches the existing sections — this is the most common regression when adding content incrementally. Use variables in Python list generation to enforce the constraint: `sec_y = 840; badge_y = sec_y - 9 # for height=18 badge`
- 8. **Marker Integrity**: Every `marker-start`, `marker-mid`, and `marker-end` URL MUST resolve to a `<marker id="...">` definition
- 9. **Visual Review Status**: Report whether the exported PNG was visually inspected; automated validation does not cover every text, legend, or arrow-arrow collision
-
- ## SVG Technical Rules
-
- - ViewBox: `0 0 960 600` default; `0 0 960 800` tall; `0 0 1200 600` wide
- - Fonts: embed via `<style>font-family: ...</style>` — no external `@import` (cairosvg / rsvg-convert cannot fetch external URLs)
- - `<defs>`: arrow markers, gradients, filters, clip paths
- - Text: minimum 12px, prefer 13-14px labels, 11px sub-labels, 16-18px titles
- - All arrows: `<marker>` with `markerEnd`, sized `markerWidth="10" markerHeight="7"`
- - Drop shadows: `<feDropShadow>` in `<filter>`, apply sparingly (key nodes only)
- - Curved paths: use `M x1,y1 C cx1,cy1 cx2,cy2 x2,y2` cubic bezier for loops/feedback arrows
- - Clip content: use `<clipPath>` if text might overflow a node box
- - Z-order (drawing order): SVG uses painter's model — later elements cover earlier ones. Recommended layer order (bottom → top): ① canvas background ② dashed containers / region backgrounds ③ arrows and connection lines ④ node shapes (rects, circles) ⑤ text labels and annotations ⑥ legends and overlays. When arrows pass near text, draw arrows BEFORE text so text stays readable. Adjust per diagram needs — this is guidance, not rigid.
-
- ## SVG Generation & Error Prevention
-
- **MANDATORY: Python List Method** (ALWAYS use this):
- ```python
- python3 << 'EOF'
- lines = []
- lines.append('<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 960 700">')
- lines.append(' <defs>')
- # ... each line separately
- lines.append('</svg>')
-
- with open('/path/to/output.svg', 'w') as f:
- f.write('\n'.join(lines))
- print("SVG generated successfully")
- EOF
+ python3 "$SKILL_ROOT/scripts/fireworks.py" version
```
- **Why mandatory**: Prevents character truncation, typos, and syntax errors. Each line is independent and easy to verify.
-
- **Pre-Tool-Call Checklist** (CRITICAL - use EVERY time):
- 1. ✅ Can I write out the COMPLETE command/content right now?
- 2. ✅ Do I have ALL required parameters ready?
- 3. ✅ Have I checked for syntax errors in my prepared content?
+ - Honor the user's diagram type, content and style; choose sensible reversible
+ details from the brief. Ask only for a material missing engineering fact or
+ a choice the user explicitly reserved. A request to draw includes local rendering.
+ - Styles 1–7 and 9–12 have JSON generators. Style 8 (Dark Luxury) remains
+ AI-authored SVG: use its style reference, then the same validation/export gates.
+ - Default to Style 1 Flat Icon when no user/workspace preference applies. Load the
+ actual matching file from [the style matrix](references/style-diagram-matrix.md).
+ Read other styles only for a requested comparison.
+ - Styles 9–12 default to C4, cloud, event and observability semantic contracts.
+ Validate facts before layout; do not invent responsibilities, protocols or metrics.
+ - Adapt an existing valid SVG directly when appropriate. JSON generation is not
+ required for every edit. Use [diagram/layout guidance](references/diagram-layout-reference.md)
+ and [icons](references/icons.md) only for the relevant type or symbols.
- **If ANY answer is NO**: STOP. Do NOT call the tool. Prepare the content first.
+ ## Generate and check
- **Error Recovery Protocol**:
- - **First error**: Analyze root cause, apply targeted fix
- - **Second error**: Switch method entirely (Python list → chunked generation)
- - **Third error**: STOP and report to user - do NOT loop endlessly
- - **Never**: Retry the same failing command or call tools with empty parameters
+ Reuse the user's current brief and artifact; an extra planning document is optional.
+ For JSON work, select `text_policy: "strict"` when all labels must be visible exactly.
+ The compatible `report` default preserves full labels in SVG metadata and reports
+ any visible truncation. Resolve that warning before claiming complete exact text.
+ For polished work apply the [composition contract](references/composition-quality-contract.md).
+ For Obsidian/Vault or `_teach` HTML output, also load
+ [Obsidian vault rendering](references/obsidian-vault.md).
- **Validation** (run after generation):
```bash
- python3 -c "import xml.etree.ElementTree as ET; ET.parse('file.svg')" && echo "✓ Valid XML"
- # Or use cairosvg as a render-time check:
- python3 -c "import cairosvg; cairosvg.svg2png(url='file.svg', write_to='/tmp/test.png')" && echo "✓ Renders" && rm /tmp/test.png
+ SKILL_ROOT="${CLAUDE_SKILL_DIR:-/absolute/path/from-codex-skill-metadata}"
+ python3 "$SKILL_ROOT/scripts/fireworks.py" validate architecture input.json
+ python3 "$SKILL_ROOT/scripts/fireworks.py" render architecture input.json diagram.svg --report layout.json
+ python3 "$SKILL_ROOT/scripts/fireworks.py" check diagram.svg
+ python3 "$SKILL_ROOT/scripts/fireworks.py" export-png diagram.svg diagram.png --width 1920
```
- **If using `generate-from-template.py`**:
- - Prefer `source` / `target` node ids in arrow JSON so the generator can snap to node edges
- - Keep `x1,y1,x2,y2` as hints or fallback coordinates, not the main routing primitive
- - Let the generator choose orthogonal routes; avoid hardcoding center-to-center straight lines unless the path is guaranteed clear
-
- **Common Syntax Errors to Avoid**:
- - ❌ `yt-anchor` → ✅ `y="60" text-anchor="middle"`
- - ❌ `x="390` (missing y) → ✅ `x="390" y="250"`
- - ❌ `fill=#fff` → ✅ `fill="#ffffff"`
- - ❌ `marker-end=` → ✅ `marker-end="url(#arrow)"`
- - ❌ `L 29450` → ✅ `L 290,220`
- - ❌ Missing `</svg>` at end
- - ❌ Element with `filter` near viewBox edge — filter region extends 20% (default) or more beyond bbox; if that region exceeds viewBox, Chrome/cairosvg clip the filter rendering AND can drop the element's own stroke on that side. Keep filtered elements at least `max(20% of element size, shadow blur radius × 3)` away from viewBox edges, or omit the filter.
-
- ## Output
-
- - **Default**: `./[derived-name].svg` and `./[derived-name].png` in current directory
- - **Custom**: user specifies path with `--output /path/` or `输出到 /path/`
- - **PNG / motion export**: see **SVG → PNG Conversion** below and `$SKILL_ROOT/references/motion-effects.md`
-
- ## SVG → PNG Conversion
-
- Use `$SKILL_ROOT/scripts/generate-diagram.sh` by default. Load `$SKILL_ROOT/references/png-export.md` only when selecting a renderer manually, handling CJK/emoji fallback, converting browser-generated SVG, or using the bundled Puppeteer converter.
-
- ## Styles
-
- | # | Name | Background | Best For |
- |---|------|-----------|----------|
- | 1 | **Flat Icon** (default) | White | Blogs, docs, presentations |
- | 2 | **Dark Terminal** | `#0f0f1a` | GitHub, dev articles |
- | 3 | **Blueprint** | `#0a1628` | Architecture docs |
- | 4 | **Notion Clean** | White, minimal | Notion, Confluence, wikis |
- | 5 | **Glassmorphism** | Dark gradient | Product sites, keynotes |
- | 6 | **Claude Official** | Warm cream `#f8f6f3` | Anthropic-style diagrams |
- | 7 | **OpenAI Official** | Pure white `#ffffff` | OpenAI-style diagrams |
- | 8 | **Dark Luxury** *(AI-authored)* | `#0a0a0a` deep black | Architecture docs, premium editorial — hand-craft SVG from `$SKILL_ROOT/references/style-8-dark-luxury.md` |
- | 9 | **C4 Review Canvas** | Warm paper `#f7f2e8` | C4 reviews and ADRs; enforces one abstraction level |
- | 10 | **Cloud Fabric** | Cloud blue `#edf5fb` | Region/network/workload deployment ownership |
- | 11 | **Event Transit** | Transit paper `#fbf7ee` | Topics, processors, consumer groups, DLQ, state |
- | 12 | **Ops Pulse** | Ops navy `#07111f` | Golden signals, critical paths, correlated traces |
+ `check` validates SVG identity, marker references, generic collisions, semantic
+ geometry and composition. Inspect the report's typography and palette scope;
+ heuristic text widths do not replace inspecting the actual rendered font.
+ Use [visual quality guidance](references/visual-quality.md) for readability and
+ style-specific refinements. Keep one semantic connector per business edge.
- Load the matching `$SKILL_ROOT/references/style-N-*.md` for exact color tokens and SVG patterns.
+ ## Additional outputs
- ## Style Selection
+ - **PNG:** prefer `export-png`, which reads root canvas dimensions, limits output
+ size, writes atomically and reads the PNG dimensions back. Alternate renderer
+ details are in [PNG export](references/png-export.md).
+ - **HTML:** `fireworks.py export-html diagram.svg diagram.html`. One sanitized
+ offline file provides pan/zoom, source copy and static image downloads.
+ - **GIF:** “Generate a GIF”, “Animate this diagram”, “生成 GIF”, “制作 GIF” and
+ “让这张图动起来” select the existing semantic SVG's motion route. Styles 1–12 are enabled
+ for the documented scene contracts; arbitrary same-style topologies are not
+ promised. Load [motion effects](references/motion-effects.md) and run
+ `fireworks.py animate diagram.svg diagram.gif`. Default is 960px, 20fps, 5.75s
+ with the `+2s-settled-flow` preset and a `.motion.json` report. Historical
+ `user-approved` fields describe maintainer-reviewed presets, not authorization
+ from the current user to publish, spend or send data.
- **Default**: Style 1 (Flat Icon) for most diagrams. Load `$SKILL_ROOT/references/style-diagram-matrix.md` for detailed style-to-diagram-type recommendations.
+ ## Verify the requested outcome
- Prompt fingerprints: `C4评审画布/C4 review board` → 9; `多区域云部署/deployment topology` → 10; `事件地铁图/event metro map` → 11; `可靠性脉冲/golden signals trace` → 12; `让这张图动起来/生成 GIF/制作 GIF/animate this diagram/Generate a GIF` → auto motion.
- Auto-select these only with matching domain evidence; otherwise use Styles 1–7 or `semantic_profile: "generic"`, and split mixed C4/deployment/event/ops views.
+ Inspect the final PNG at intended reading size when image viewing is available:
+ check text completeness, contrast, font substitution, hierarchy, spacing, clipping,
+ arrow direction, crossings and labels. Preserve style palette and material while
+ fixing defects. Reuse an unchanged reviewed render; do not keep adding tests or
+ polish after acceptance passes. If viewing is unavailable, explicitly mark the
+ visual check skipped and do not claim visual correctness. Run this QA with a
+ non-interactive renderer and the available local image-inspection tool; do not
+ navigate, claim, or reuse the user's active browser tab.
- These patterns appear frequently — internalize them:
+ After a failed check, use its element IDs and geometry to make a focused repair;
+ change the approach after two unchanged failures. Widen/split an overfull diagram
+ instead of hiding required copy or endlessly shrinking type. Do not silently
+ weaken semantic or composition constraints to obtain a pass.
- **RAG Pipeline**: Query → Embed → VectorSearch → Retrieve → Augment → LLM → Response
- **Agentic RAG**: adds Agent loop with Tool use between Query and LLM
- **Agentic Search**: Query → Planner → [Search Tool / Calculator / Code] → Synthesizer → Response
- **Mem0 / Memory Layer**: Input → Memory Manager → [Write: VectorDB + GraphDB] / [Read: Retrieve+Rank] → Context
- **Agent Memory Types**: Sensory (raw input) → Working (context window) → Episodic (past interactions) → Semantic (facts) → Procedural (skills)
- **Multi-Agent**: Orchestrator → [SubAgent A / SubAgent B / SubAgent C] → Aggregator → Output
- **Tool Call Flow**: LLM → Tool Selector → Tool Execution → Result Parser → LLM (loop)
+ Complete every requested local output and its applicable checks, then report file
+ paths, dimensions, visual review and residual limitations. A first SVG does not
+ complete a requested PNG/GIF/HTML package. Publication or remote delivery requires
+ its own scope-matching authorization; existing authorization is not requested twice.