system-design-report-generator

name	system-design-report-generator
description	Scaffold or maintain a system design report as a folder of section .md files plus a small hub index with llm_toc (file paths for LLM partial reads). MemNet-first when serve is up: pin_map(TSK_model_*) before prose, atomise @ART/@SEC/@CLM after sync. Triggers: system design report pack, split outputs sections, outputs folder system design, multi-file system design, hub index llm_toc file, memnet report sync.
metadata	{"pattern":"pipeline","domain":"mbse-outputs","version":"2.5","pairs_with":["project-output-article","sysml-view-doc-sync","sysml-memnet-documentation","sysml-modeling-workflow","mermaid","mmdc","md-to-tex","mdtohtml"]}
token_guardrails	- **Hub first:** agents read **`index.md`** (or `README.md`) only for full-file list — **low line count (LOC)** — then open **one** `file` from `llm_toc` per task; do not load every section `.md` into context by default. - **MemNet before prose (when serve up):** `serve_status` → `pin_map(TSK_model_<short>)` → then hub → **one** section file. Do not grep-deploy from memory when warm rows exist. - **Normative layout:** [references/SYSTEM_DESIGN_REPORT_LAYOUT.md](references/SYSTEM_DESIGN_REPORT_LAYOUT.md) — do not invent a second competing root under `docs/`. - **MemNet pipeline:** [references/memnet-report-pipeline.md](references/memnet-report-pipeline.md) -- ART/SEC/claim atoms after sync; G/M step codes per [sysml-memnet-pipeline.md](../sysml-memnet-documentation/references/sysml-memnet-pipeline.md) (GQL / openCypher-shaped only). - **Model wins:** deploy/connections/behaviour/requirements `.sysml` stay authoritative; **sysml-view-doc-sync** after edits. Keep `10-requirements-traceability` and `outputs/diagrams/` plant-setup flows aligned with refine/derive + behaviour. - Report sections are **human-first**: write compact, precise prose. Prefer tables, bullets, and short notes; avoid long introductory filler and avoid restating the same fact in multiple sections. - If a section can be understood from a table plus one short sentence, do that instead of a paragraph. - **UTF-8 encoding:** All `.md` files **must** be UTF-8 encoded (no mixed encoding, no BOM). Merge using Python (see skill): read each file with explicit `encoding='utf-8'`, combine in order, write merged output as UTF-8. **No Unicode sanitization needed** — proper UTF-8 handles all special characters (–, →, ↔, ×, §) correctly. - **Section files are merge inputs only:** Remove all inter-section cross-references ("See chapter X", "See section Y") before merging. Individual files are not meant to be read standalone. - **Do not commit merged files to git** — keep only section `.md` files as authoritative source; generate exports (merged `.md`, HTML, LaTeX) on-demand using Python merge script.

System design report generator (multi-file pack)

When: A system design (or similar) narrative is large enough that one monolithic *-system-design.md is hard for agents to navigate, or the team wants sections as separate files with a machine-readable map (llm_toc with file entries).

These packs are for human readers too, so keep each section tight and purposeful. The hub should orient the reader; the section files should explain only what is needed.

Pairing

• project-output-article — same section semantics and Mermaid rules; this skill adds folder + file split + hub llm_toc.
• sysml-view-doc-sync — update every touched section file after deploy changes.
• sysml-memnet-documentation — pin_map before generate/maintain; atomise @ART/@SEC/@CLM after sync (memnet-report-pipeline.md).
• sysml-modeling-workflow — validate .sysml before report delta; report maintenance is step 5 follow-on, not a substitute for model snap.
• md-to-tex — pass hub llm_toc order as Pandoc input list for multi-file → one .tex.
• mdtohtml — export section files to HTML (Mermaid rendering, UTF-8 safe, handles encoding correctly).

Pipeline

A — Generate or refresh full pack

1. MemNet preflight — serve_status. If up: read AGENT-CONTEXT.md → pin_map(TSK_model_<short>, depth=2). Warm miss → initial model snap per sysml-memnet-documentation before writing prose.
2. Read layout — references/SYSTEM_DESIGN_REPORT_LAYOUT.md (folder name, hub schema, section filenames, LOC discipline).
3. Create or adopt folder — Under , use pack root (or legacy if the project already started — one pack per project, ).