| name | reverse-engineering |
| description | Produces and incrementally maintains a versioned reverse-engineering dossier for a subject — a legacy codebase, a microservice, a third-party API, an internal library, a data pipeline. Output is markdown chapters under `docs/support/reverse/<subject-slug>/`, combining project documents (sprint inputs, meeting notes, functional specs) with the subject's code/artifacts indexed via the graphify knowledge graph. Flow — (1) graphify indexing loads context only, (2) long-running interactive Q&A on graph and source, (3) explicit save trigger ("save", "ok write it", "make v1.5") bumps minor version, updates only chapters in the consolidated intent, appends a changelog entry. Triggers — "reverse-engineer X", "document legacy Y", "build a dossier on vendor Z's API", "refresh the reverse on <subject>", "new version of the reverse", or mention of a path under `docs/support/reverse/` in an update context. Do NOT use for one-shot graph queries or single-chapter manual edits. |
| source | Risko reference-project (reworked whitelabel for NONoise) |
| variant | nonoise generic; stack-neutral; output under docs/support/reverse/<subject-slug>/ |
reverse-engineering — versioned reverse dossier for any subject
This skill maintains a reverse-engineering dossier for a named subject under:
docs/support/reverse/<subject-slug>/
├── 00-overview.md
├── 01-<chapter>.md
├── 02-<chapter>.md
├── ...
├── CHANGELOG.md ← versioned history, newest on top
└── .meta/
└── graphify-index.json ← pointer to the subject's graph (not versioned content)
A subject is anything worth a dedicated dossier: a legacy codebase you're porting, a current microservice you need to document, a vendor API you're integrating, an internal library inherited from another team, a data pipeline, a monolith module being extracted. The methodology applies equally to legacy-understanding and to current-system documentation — the same chapters, the same workflow, the same versioning.
<subject-slug> is free-form kebab-case. Examples:
legacy-billing — an old billing system being decommissionedvendor-stripe-api — a third-party API you depend onmicroservice-payments — a current service whose behavior is tribal knowledgelibrary-internal-orm — an internal library inherited from another teammonolith-inventory — a module in an existing monolith being extracted
The output is a minor-version bump of the dossier (v1.N → v1.N+1) each time you save: only the chapters impacted by the current intent are rewritten, plus one new entry at the top of CHANGELOG.md. Everything else stays byte-identical — git diffs stay review-able.
Guiding principles
- Incremental, not one-shot. The dossier evolves over many sessions. We never rewrite from scratch; we edit the minimum subset of chapters implied by the user's intent.
- Never write on our own initiative. Indexing and analysis happen freely in chat, but the target folder is not touched until the user says "save" (or equivalent). A reverse session can run for hours and produce dozens of scratch drafts — most are discarded; only the final consolidated result reaches disk.
- Graphify is context, not output. The knowledge graph produced by graphify is consumed to answer questions during the loop; it is not re-indexed on save and it is not copied into the dossier.
- Source documents are read-only. Project inputs (sprint docs, meeting notes, research PDFs, code) are sources. The dossier is a derived artifact. Don't write back.
When to use this skill
Activate when the user says (either language of the project):
- "reverse-engineer X" / "build a reverse on X" / "document X"
- "refresh/update/regenerate the reverse of "
- "new version of the dossier on "
- "add what emerged from <meeting/PRD/spec> to the reverse of "
- "we have a new BR/spec/note, update the reverse"
- "let me walk through with you, then we save"
- mentions a path under
docs/support/reverse/<subject>/ in an update context
Do not activate for:
- Ad-hoc questions on the graph ("how does X work in the legacy?") → route to
/graphify query
- Single-chapter manual edit outside a version bump → use
Edit directly
- Pure indexing of a folder with no dossier production → use
/graphify <path>
Working language
Follow the project's working language. Resolution order:
- If
nonoise.config.json has a top-level language key, use it.
- Else, infer from the existing dossier (if
00-overview.md is written in French, continue in French).
- Else, default to English.
Terminology and chapter titles should match whatever language the dossier already uses. Do not switch language mid-version.
Position in the workflow
The reverse-engineering skill does not belong to the "architectural" workflow (arch-brainstorm → arch-decision → sprint-manifest → atr). It is an investigative / documentary skill that feeds into the others:
┌─────────────────────┐ feeds context ┌──────────────────┐
│ reverse-engineering │ ───────────────▶ │ arch-brainstorm │
│ (THIS SKILL) │ (the dossier │ arch-decision │
│ │ becomes a │ sprint-manifest │
│ produces a dossier │ reference │ │
│ under docs/support/ │ during │ │
│ reverse/<subject>/ │ planning) │ │
└─────────────────────┘ └──────────────────┘
The dossier lives in docs/support/ — the NONoise convention for research / supporting docs / legacy analysis / anything that informs decisions without being a decision itself.
Flow — 7 steps
- Step 0 — prerequisites
- Step 1 — collect input (subject slug, source folders)
- Step 2 — graphify indexing (loads context only)
- Step 3 — interactive analysis loop (the heart — user-driven, no writes)
- Step 4 — explicit save trigger + current-version read
- Step 5 — regeneration of impacted chapters (only after save)
- Step 6 — metadata + CHANGELOG update + summary
Steps 0–3 are linear. Steps 4–6 fire only when the user utters a save phrase (see 4.1). Hours and dozens of Q&A rounds can pass between Step 3 and Step 4 — that is normal.
Step 0 — Prerequisites
0.1 — graphify installed AND /graphify skill registered
Two checks. Both must pass — the binary alone is not enough (see Hard rule #11: this skill must never invoke the bare graphify CLI for indexing).
Check A — binary is on PATH
graphify --help >/dev/null 2>&1 && echo "BIN_OK" || echo "BIN_MISSING"
Check B — /graphify slash skill is registered in the active IDE
The semantic-extraction step runs through the IDE assistant's own model (no external API key required) only when the /graphify skill is loaded. Probe the platform-specific install paths:
test -f "$HOME/.claude/skills/graphify/SKILL.md" && echo "CLAUDE_OK"
test -f "$HOME/.copilot/skills/graphify/SKILL.md" && echo "COPILOT_OK"
test -f "$HOME/.cursor/rules/graphify.mdc" && echo "CURSOR_OK"
At least one of those must print OK on the IDE the user is currently in. If none do, the bare CLI is the only path left — and that path requires an API key, which is exactly what we're avoiding.
If Check A fails:
Graphify is not installed. It's normally installed at scaffold time by create-nonoise. Re-run the scaffold's graphify-only mode (idempotent, safe on existing projects):
npx create-nonoise@latest --graphify-only
Or install manually:
uv tool install "graphifyy>=0.7.0"
If uv is not available, bootstrap it first:
- macOS / Linux:
curl -LsSf https://astral.sh/uv/install.sh | sh
- Windows:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
Can't proceed without graphify — re-run me once it's installed.
If Check A passes but Check B fails (binary present, skill not registered):
The graphify binary is installed, but the /graphify slash skill is not registered in your IDE. Without it, the indexing step would fall back to the headless CLI (graphify extract), which requires a separate LLM API key (ANTHROPIC_API_KEY / MOONSHOT_API_KEY / OPENAI_API_KEY). That defeats the point of running through the IDE assistant.
Register the skill (idempotent):
npx create-nonoise@latest --graphify-only
This re-runs the per-IDE skill install (graphify claude install / graphify copilot install) inside this project. After that, restart the IDE chat session so the skill is picked up, then re-run me.
Cannot proceed — Hard rule #11 forbids the bare CLI path.
Then stop.
0.2 — Local developer config
Paths to external/legacy repos are developer-specific. Read them from .reverse-engineering.local.json at repo root.
test -f .reverse-engineering.local.json && cat .reverse-engineering.local.json || echo "MISSING"
Expected structure (see references/config.example.json):
{
"subjects": {
"legacy-billing": {
"source_path": "C:\\path\\to\\legacy-billing",
"last_run": "2026-04-15T10:00:00Z",
"last_source_indexed": "docs/sprints/Sprint-3"
}
}
}
If the file is missing, create it empty ({ "subjects": {} }) and add it to .gitignore if it's not already there:
grep -q "^.reverse-engineering.local.json$" .gitignore 2>/dev/null || echo ".reverse-engineering.local.json" >> .gitignore
This file holds machine-local paths and must never be committed.
0.3 — Destination root exists
test -d "docs/support/reverse" || mkdir -p "docs/support/reverse"
The per-subject folder (docs/support/reverse/<subject-slug>/) is created on first save, not here.
Step 1 — Input collection (pre-indexing)
Collect only what is needed to index. Do not ask about chapter scope here — that emerges during Step 3.
Q1 — Subject slug
Q1: Which subject are we working on? Give me a short kebab-case name (e.g. legacy-billing, vendor-stripe-api, microservice-payments).
If a folder docs/support/reverse/<slug>/ already exists, we'll update that dossier. Otherwise we start a new one.
Validate: must match ^[a-z0-9][a-z0-9-]*$. No slashes, no spaces, no uppercase.
Check existence:
test -d "docs/support/reverse/<slug>" && echo "UPDATE" || echo "NEW"
If NEW, confirm with the user that they want to create a fresh dossier — first-time generation usually needs a larger initial pass than an incremental update.
Q2 — Project document folders to index
These are the non-code sources: sprint inputs, meeting notes, business analysis calls, functional specs, requirements, research. Default suggestion:
ls docs/sprints/ 2>/dev/null | grep -E "^Sprint-[0-9]+$" | sort -V | tail -1
Ask:
Q2: Which folders contain the project documents to feed the reverse?
Suggested default: docs/sprints/<most-recent>/.
You can accept, change it, or pass multiple comma-separated (e.g. docs/requirements/billing, docs/calls/2026-04-10-billing-kickoff). Typical sources in NONoise projects are under docs/sprints/, docs/requirements/, docs/calls/, docs/support/.
Guard — hard rule: reject any path that is or contains docs/support/reverse/<slug> — the destination is never a source:
Can't index docs/support/reverse/<slug>/ — it's the output folder, not a source. Pick a different path.
Q3 — Subject source (code / artifact repo)
Ask:
Q3: Where is the subject's source (code, artifacts, whatever we are reverse-engineering)? Examples:
- legacy repo:
C:\...\legacy-billing
- a folder inside this repo:
services/payments
- a vendor-api spec folder:
docs/support/vendor-stripe-api/openapi
⚠️ Source indexing is essential for this skill. A document-only reverse produces source-less chapters for everything touching internals, data model, and main flows — those become stubs with open points instead of analysis.
If you truly have no source (pure vendor-spec case), type exactly skip-no-source. I'll ask for explicit confirmation before accepting.
If the user provides a path, store/update it under .reverse-engineering.local.json → subjects.<slug>.source_path and validate it exists.
If the user types skip-no-source, ask the confirmation prompt immediately:
You chose document-only mode. The dossier will be partial: internals-, data-model-, and main-flow-style chapters will be stubs flagged as "source not indexed". This is appropriate only when no source exists (pure vendor/spec reverse).
Confirm? Type yes to proceed without source. Anything else returns to Q3.
Only a literal yes (case-insensitive) moves forward. Any other response (including empty) returns to Q3. When the user confirms, set the in-run flag source_less_run = true (used later in Step 2.4 and Step 6).
Q4 — Reuse or re-index the subject's graph?
If the user already confirmed source_less_run at Q3, skip Q4 entirely — there's nothing to reuse or reindex.
Otherwise check graph presence:
test -f "<source_path>/graphify-out/graph.json" && echo "EXISTS" || echo "MISSING"
Freshness check (when EXISTS): read indexed_at from
<source_path>/graphify-out/manifest.json if present, else fall back to
the file mtime of graph.json. Compute age in days. Read
reverse.graph_freshness_days from nonoise.config.json; default 30.
Case EXISTS, fresh (age ≤ threshold):
Q4: The subject graph at <source_path>/graphify-out/ is fresh — indexed N days ago. Reuse it as-is, or re-index to pick up any changes? Default: reuse. Type reindex to force.
Case EXISTS, stale (age > threshold):
Q4: The subject graph at <source_path>/graphify-out/ was last indexed N days ago (threshold: T days). If the codebase has moved since, a stale graph can mislead the reverse.
Recommended: reindex. Press Enter (or type reindex) to rebuild, or type reuse to keep the old graph anyway.
Default flips from reuse to reindex in this case — empty input = reindex.
Case MISSING (first time for this subject):
Q4: No existing graph at <source_path>/graphify-out/. Indexing is essential — without it, chapters that depend on source become source-less stubs.
Proceed? (yes / skip-no-source) — indexing can take several minutes on large codebases.
If the user types skip-no-source here, run the same explicit confirmation prompt used in Q3:
You chose document-only mode. Confirm? Type yes to proceed without source. Anything else returns to Q4.
Only yes sets source_less_run = true and moves on.
Pre-indexing summary
Print a terse recap — do not mention a target version or chapter intent (those surface only after the loop):
Indexing plan:
- Subject:
<slug> — status: NEW / UPDATE
- Document folders:
<q2 paths>
- Subject source:
<q3 path or skipped> — mode: reuse / reindex / initial
- Current dossier version (reference): v1.N (or "first version")
Proceeding will load context only. I will not write anything under docs/support/reverse/<slug>/ until you explicitly say "save" (or equivalent). Go? (yes/no)
Step 2 — graphify indexing
2.0 — Only indexable content — hard rule
Graphify must see useful text only. Before indexing, filter:
- Raw PDFs: the convention in NONoise projects is to convert PDFs to markdown upstream (a
tools/md-extractor or equivalent produces a sibling .md with extracted images). If you find a .pdf:
- If a sibling
.md exists → exclude the .pdf, keep the .md as canonical source.
- If not → block the skill and tell the user: "File
<name>.pdf has no markdown sibling. Convert it (e.g. via tools/md-extractor if the project ships one) before re-running the reverse. I don't index raw PDFs because graphify processes them worse than a cleanly-extracted markdown."
- PDF-conversion artifact folders (
*/page_N_image_M.jpg, chart dumps, etc.): exclude any folder whose files are >80% page_*_image_* or page_*_chart_* noise.
docs/support/reverse/<slug>/: destination, never input (see 2.3).- Residual
graphify-out/ inside a source path: output of a previous run, not input. Remove before re-indexing.
- Broken
.docx / .xlsx: if graphify's Office extra isn't installed, tell the user to either convert manually to .md or install graphifyy[office].
Extra textual formats not recognized natively as document by graphify — add them manually:
Legacy code with no AST parser — reclassify as document. Graphify's structural extraction (AST) only handles modern languages with available parsers (Python, TypeScript, Go, Rust, Java, C/C++, Ruby, Swift, Kotlin, C#, Scala, PHP, Lua). Legacy code falls through that step and loses all signal. The fix is to move it into the document bucket so the semantic LLM pass reads it as prose — which is the correct approach for legacy reverse-engineering: the LLM extracts programs, paragraphs, PERFORM/CALL targets, copybook references, file/dataset names, DATA DIVISION items and so on directly from the text. Don't go hunting for COBOL AST parsers — they're either missing, half-baked, or worse than the LLM.
Affected extensions:
- COBOL (
.cbl, .cob, .cpy), RPG (.rpg, .rpgle), FORTRAN (.f, .f90, .for), JCL (.jcl), PL/I (.pli, .pl1), ABAP (.abap), Assembler (.asm, .s). Extend the set if the subject uses other legacy dialects (CLIST, REXX, NATURAL, Easytrieve, etc.).
After detect():
LEGACY_EXTS = {'.cbl','.cob','.cpy','.rpg','.rpgle','.f','.f90','.for',
'.jcl','.pli','.pl1','.abap','.asm','.s'}
files = result['files']
moved = [f for f in files.get('code', []) if Path(f).suffix.lower() in LEGACY_EXTS]
if moved:
files['code'] = [f for f in files['code'] if f not in moved]
files.setdefault('document', []).extend(moved)
print(f'Reclassified {len(moved)} legacy file(s) as documents (no AST parser).')
When the subject source (Q3) is mostly legacy code, always apply this before invoking graphify on it (Step 2.2). Print to the user which extensions were reclassified so they understand why the AST node count is low / zero.
After filtering, show the user before/after counts and the final file list. If total > 200 (graphify threshold) or > 15 post-filter, ask explicit confirmation.
PDF note (print once per run when you detect raw PDFs):
PDF note: NONoise projects typically convert PDFs to markdown via a project-local tool (e.g. tools/md-extractor) — not via graphify's built-in extractor. The sibling .md is the canonical indexable source. If your project has a different convention, wire it up and re-run.
2.1 — Document folders (from Q2)
For each path:
test -f "<path>/graphify-out/graph.json" && echo "EXISTS" || echo "MISSING"
EXISTS → /graphify "<path>" --update (incremental, semantic cache reuse) if the intent suggests new material ("new", "added", "update", "changed"); else reuse.MISSING → /graphify "<path>" full build.
Quote paths — they can contain spaces. graphify writes to ./graphify-out/ relative to CWD; move under <path>/graphify-out/ if needed for consistency and future incremental runs.
Invocation note — see Hard rule #11. /graphify <path> is a slash skill invocation, NOT the graphify binary. The bare CLI's extract subcommand requires an external LLM API key; the slash skill runs the same pipeline through the IDE assistant's model with no key required. In Claude Code: type /graphify <path> or call Skill(skill: "graphify", args: "<path>"). In Copilot / Cursor / Gemini / Codex / any IDE without slash commands: open the skill file at the path probed in Step 0.1 (Check B) and follow its steps. The bare CLI is allowed only for read-side ops: graphify update <path> (AST-only), graphify cluster-only, graphify query/path/explain. For a reverse dossier we always need the semantic pass — always the skill, never graphify extract.
2.2 — Subject source (from Q3/Q4)
reuse → nothing to do.reindex → /graphify "<source_path>" --update if graph exists, else /graphify "<source_path>" (full pipeline).initial → /graphify "<source_path>" (full pipeline — AST + semantic + clustering).- skipped → no source graph (some chapters will be source-less; warn the user).
Same invocation note as 2.1 applies — /graphify is the skill, not the bare CLI.
After completion, verify the semantic pass actually ran by checking graphify-out/GRAPH_REPORT.md — on an initial build, the "Token cost" line should be non-zero. If it reports 0 input · 0 output on a brand-new build, the LLM extraction was skipped (likely credentials missing, or --no-semantic slipped in). Surface this to the user — the report will be near-empty without semantic edges.
Large codebases can take minutes — show progress if available.
2.3 — Anti-destination guard
Before every graphify call, verify the target path is not, contains, nor is contained in docs/support/reverse/<slug>. If it resolves there, abort:
Defensive abort: this skill is about to index docs/support/reverse/<slug>/ which is the output folder. Never do that. Please re-check the paths you gave in Q2/Q3.
Q1/Q2 already filter — this is the safety net.
2.4 — Persist graph pointer
After successful indexing, write/refresh docs/support/reverse/<slug>/.meta/graphify-index.json (creating the folder if needed — the parent <slug> folder may not exist yet if this is a NEW subject):
{
"subject": "<slug>",
"document_graphs": [
{ "path": "<q2-path-1>/graphify-out", "indexed_at": "<iso>" },
{ "path": "<q2-path-2>/graphify-out", "indexed_at": "<iso>" }
],
"source_graph": { "path": "<source_path>/graphify-out", "indexed_at": "<iso>" },
"source_less_run": false,
"updated_at": "<iso>"
}
When the in-run flag source_less_run (set by Q3 or Q4 confirmation) is
true, write "source_graph": null and "source_less_run": true. This
file is read by Step 6 on save to decide whether to emit the overview
banner and the CHANGELOG warning.
This file is the only one the skill may create before a save trigger. It's metadata, not content — no chapter ever lives in .meta/. Add .meta/ to a project .gitignore if the user prefers local-only graphs; the decision is the user's.
Step 3 — Interactive analysis loop (the heart)
Once indexing is done, do not write anything. Open the loop.
3.1 — Post-indexing summary
Show concisely, in markdown, from GRAPH_REPORT.md and friends:
- node / edge / community counts per graph
- top 10 God Nodes (highest-degree — most central concepts)
- 5-6 Surprising Connections
- 4-5 Suggested Questions the graph is uniquely positioned to answer
Then open the loop with a question:
What do you want to analyze? You can ask me to trace a relationship (/graphify query, /graphify path, /graphify explain), compare scenarios, inspect the subject source, read specific passages from the documents, or ask thematic syntheses. When the discussion produces a result you want to freeze into the dossier, say "save" (or equivalent) and we'll move to writing. Until then, nothing changes in docs/support/reverse/<slug>/.
3.2 — Behavior during the loop
- Answer using: the freshly-built graphs, the subject source (via its graph or direct inspection), the document folders, the current dossier chapters (read-only for context).
- Show drafts in chat, never on disk. If the user says "draft this chapter so I can see", reply with the markdown in chat — do not write the file.
- Track mentally which points the user seems happy to freeze. When the save trigger fires, you'll use that trail to derive the scope.
- Do not propose a save on your own. The user may want to iterate more. At most, occasionally and softly note "this draft is ready whenever you want to save" and leave the decision alone.
- Do not announce target versions (v1.5, v1.6) during the loop — that can mislead the user into thinking you're about to write.
3.3 — Tools allowed in the loop
- Direct
Read on source files (chapters, documents, code)
/graphify query "..." on any of the indexed graphs/graphify path "A" "B" for relationships/graphify explain "X" for single nodes- Sub-agents (
general-purpose) for targeted searches on big folders
Grep / Glob on source- Transient drafts in chat (never on file)
3.4 — Hard guard — no silent writes
During Step 3, any Write or Edit on a path inside docs/support/reverse/<slug>/ is forbidden (except .meta/graphify-index.json from 2.4). If you catch yourself thinking "I'll just write chapter NN because I've understood the problem", stop and wait for the explicit trigger.
If a write slips through without a trigger, abort and explain: "I've prepared these edits as a draft but won't commit them to disk until you say 'save'."
Step 4 — Save trigger + current-version read
Step 4 starts only when the user utters a save phrase.
4.1 — Recognizing the save trigger
Valid triggers (non-exhaustive — use judgement from context):
- "save" / "save it" / "save them"
- "ok, looks good, write it"
- "ok, write v1.5"
- "go to write mode" / "go ahead and persist this"
- "commit it to the reverse" / "push it into the dossier"
- "update the reverse" / "update the dossier"
- "make v1.5" / "bump the version"
- "ok, let's persist this result"
Translations in other working languages count too (e.g. Italian "salva", French "enregistre", Spanish "guarda").
If the message is ambiguous (e.g. "interesting, keep going" — not a save), stay in Step 3.
Once recognized, confirm out loud before acting:
Ok, moving to write mode. Before I touch docs/support/reverse/<slug>/ I'll show you the scope I plan to save and wait for your green light. (see 4.3)
4.2 — Current-version read
If the dossier exists (UPDATE case), read docs/support/reverse/<slug>/00-overview.md and look for the frontmatter or header line:
**Version**: 1.N
Extract N as integer. Target version = 1.(N+1). Keep both v_current and v_next.
If the line is missing or malformed, stop and ask the user to fix 00-overview.md by hand.
If the dossier does not exist (NEW case), target version = 1.0. No previous to read.
4.3 — Consolidated intent
Distill, from the Step 3 loop, what was actually discussed and is worth persisting. Show the user for confirmation:
From the loop I've understood that v should freeze:
- [topic 1] — impacts chapters [NN, NN]
- [topic 2] — impacts [NN]
- [new chapter proposed:
NN-<name>.md]
Confirm this scope? Add, remove, or reshape anything?
If the user corrects, iterate (still in Step 4). On confirmation, move to Step 5.
Step 5 — Regenerate impacted chapters
This is the writing core. Never rewrite chapters that are not in the consolidated intent.
5.1 — Chapter scope
Combine three signals:
- User intent (from 4.3). E.g. "add the retry semantics to the payment flow" → candidate chapters are the ones about payment flow, retries, open points.
- Graph delta. If you re-indexed the document graph with
--update, compare the report before/after (if available) — look at new god nodes, new communities, new source files, INFERRED similarity edges bridging new material to old chapters.
- Temporal delta. If the user said "everything new in the last 2 days", use
git log --since="2 days ago" --name-only -- <q2-path> and map each modified file onto the chapters that cite it.
Produce ChaptersToUpdate = [NN-file.md, ...] and show for confirmation:
Based on the intent and the delta I'll update these chapters:
NN-<name>.md — direct intentNN-<name>.md — indirect (contains an example of the changed flow)NN-<name>.md — adds open point OP-...
Confirm? Add or remove?
Accept corrections before proceeding.
5.2 — Per-chapter regeneration via sub-agent
For each chapter in ChaptersToUpdate, dispatch a sub-agent (general-purpose) with a structured prompt:
You are a per-chapter regeneration sub-agent for the reverse-engineering
dossier of subject "<slug>" in this project.
## Context
The document `docs/support/reverse/<slug>/<NN-file.md>` is a chapter
of the dossier, currently at version v<current>, moving to v<next>.
## Current chapter content (preserve what's still valid)
<full content read from the file>
## User intent for the new version
"<the user's verbatim message(s) that form the consolidated intent>"
## Available sources
1. **Project documents** under <list of Q2 paths>:
indexed with graphify at <paths>/graphify-out/
2. **Subject source** at <source_path> (if provided):
- graph.json, GRAPH_REPORT.md
- raw source code/artifacts under <source_path>
3. **Other chapters of this dossier** (cross-reference, read-only):
`docs/support/reverse/<slug>/` (all `NN-*.md`)
## Source availability
<source_less = true | false>
- `false` → full source graph available; produce an analytic chapter that
draws directly from code structure, god nodes, and main flows.
- `true` → this is a source-less run. The chapter must be a stub:
- State clearly at the top that internals-, data-model-, and
main-flow-level claims are not validated against source.
- Where a section would need source, write "⚠️ source not indexed
— to be validated in a future version with subject indexing".
- Keep document-derived content (requirements, calls, specs) intact.
## Instructions
1. Read the current chapter in full.
2. Identify what changes based on the user intent.
3. Query the graph(s) for objective data where relevant.
4. Read the pertinent source documents / code.
5. Produce a new version of the chapter that:
- preserves everything still valid
- updates the parts that changed
- keeps the style, format, navigation headers
- updates any cross-references to other chapters
- adds explicit warning / open-point markers if the intent touches
decisions not yet validated
6. Write the result to `docs/support/reverse/<slug>/<NN-file.md>`
(overwrite).
## Constraints
- DO NOT rewrite from scratch if not strictly necessary
- DO NOT modify chapters other than the one assigned
- Preserve the project's working language and domain terminology
- Preserve mermaid diagrams, tables, formulas as-is
- If you find information contradicting the existing chapter, surface it
explicitly in the text — never silently
- Do not change the file number or title — only the content
## Output
Report back as a JSON block for the parent skill to parse:
{
"path": "docs/support/reverse/<slug>/<NN-file.md>",
"summary": "2-3 sentences on what changed",
"warnings": ["any warning / validation request to propagate to the CHANGELOG"],
"source_less": true | false
}
The `source_less` field MUST be set. If missing, the parent skill treats it as `true` (worst-case assumption) and lists the chapter in the CHANGELOG source-less block.
Parallelism: if you have more than ~3 chapters, dispatch sub-agents in parallel (multiple tool calls in the same message). Chapters are independent (cross-refs are static titles, not dynamic bodies) — parallel is safe.
5.3 — New chapters
If the intent implies a new chapter that doesn't exist yet (e.g. "add a chapter on the auth flow"), propose:
The intent mentions "auth flow" which has no dedicated chapter. I propose:
- filename:
NN-auth-flow.md (NN = next free number)
- position: append at the end (no renumbering of existing chapters)
Confirm? Or tell me where to slot it.
Numbering rule: always append at the first free number. Never renumber existing chapters — renumbering breaks cross-references and git history.
On confirmation, dispatch a sub-agent analogous to 5.2 but tasked to create the chapter from scratch, with navigation headers consistent with siblings.
5.4 — First-version case (dossier doesn't exist)
If NEW (4.2 case, target v1.0), the scope is different: there's no current content to preserve. The user in 4.3 must specify which chapters to generate (or accept a proposed initial spine). Minimal default spine:
00-overview.md — subject summary, scope, versioning convention01-context.md — why this subject, what problem it solves02-entry-points.md — how the subject is invoked / accessed03-data-model.md — key entities, relationships, invariants04-main-flows.md — critical user/system flows99-open-points.md — assumptions, gaps, things to validate
Adapt the spine to the subject. Dispatch one sub-agent per chapter in parallel with a "generate from scratch" variant of the 5.2 prompt. Always write 00-overview.md first or last (it references the others).
Step 6 — Metadata and CHANGELOG
6.1 — Update 00-overview.md
In docs/support/reverse/<slug>/00-overview.md, update:
**Version**: 1.N → **Version**: 1.(N+1)**Date**: <previous date> → today, in the dossier's language (e.g. 15 April 2026, 15 aprile 2026)- If new chapters were added in 5.3, update the chapter list / table of contents if the overview includes one.
Source-less banner (depends on source_less_run from .meta/graphify-index.json):
-
If the CURRENT run is source-less → insert (or replace if already present) this managed block immediately after the H1 title:
<!-- >>> source-less-warning (managed by reverse-engineering skill) -->
> ⚠️ **Partial reverse**: this dossier version was produced without subject-source indexing. Chapters covering internals, data model, and main flows are document-derived only. Re-index via `/graphify <source_path>` and run a new save to upgrade.
<!-- <<< source-less-warning -->
-
If the current run IS source-indexed AND a managed block with these markers already exists in the file (leftover from a previous source-less run) → remove it. This makes the banner self-clearing on the first save that restores source indexing.
-
Marker-delimited — replay-safe; never duplicate.
Only 00-overview.md is touched here. Other chapters' headers are updated by the sub-agents of 5.2/5.3, not by this step.
6.2 — Update CHANGELOG.md
If CHANGELOG.md does not exist (first save), create it with:
# Changelog — reverse dossier `<slug>`
Version history of the reverse-engineering dossier at `docs/support/reverse/<slug>/`.
Newest versions on top.
---
Then prepend (above any existing entries) a new entry using the template at references/changelog-entry.md. Fields:
- Version:
v<next> (e.g. v1.5)
- Date: today
- Type:
regeneration M1 (or initial for v1.0)
- Inputs: document folders indexed with counts + subject graph mode (reuse / re-indexed / skipped) + node/edge stats
- User intent: verbatim quote of the consolidated intent from 4.3
- Changes: one bullet per impacted chapter, derived from each sub-agent's summary
- Impacted chapters: list of
NN numbers
- New chapters: list of new files, or "none"
- Unchanged chapters: count
- Warnings / open points: propagated from sub-agents, or "none"
- Sources consulted: top-level references the sub-agents used
Source-less run tracking: when source_less_run = true (read from
.meta/graphify-index.json), the CHANGELOG entry MUST include the
source-less block from the template. Populate the chapter list from the
sub-agents' source_less: true return values — one entry per chapter
that could not be analyzed due to missing source indexing. When
source_less_run = false, omit the block entirely.
6.3 — Update .reverse-engineering.local.json
Under subjects.<slug>, write:
last_run: current ISO timestamplast_source_indexed: the first Q2 path (for the Q2 default on the next run)
6.4 — Summary
Print to the user:
✅ Reverse dossier <slug> updated
Version: v1.4 → v1.5
Date: <today in dossier language>
Chapters changed (N):
- NN-<name>.md (<1-line summary>)
- NN-<name>.md (<1-line summary>)
...
New chapters: <list or "none">
Unchanged chapters: K of total T
Output under docs/support/reverse/<slug>/
Changelog updated at docs/support/reverse/<slug>/CHANGELOG.md
Suggested next steps:
- Review the changed chapters
- Commit on the current branch
- If new open points were raised, schedule the relevant review
Hard rules (invariant — cannot be bypassed)
- Never index
docs/support/reverse/<slug>/ — it's the output. If a selected path collides, reject.
- Never invoke
graphify without verifying install in Step 0.1.
- Never write under
docs/support/reverse/<slug>/ without an explicit save trigger — the cardinal rule. During indexing (Step 2) and the entire loop (Step 3), any Write / Edit under that folder is forbidden (except .meta/graphify-index.json from 2.4, which is metadata). The transition to Steps 4–6 happens only when the user utters a save phrase (4.1). If you're about to write without a trigger, stop and ask.
- Never skip the current-version read from
00-overview.md — it's the ground truth for the bump. Missing → abort run.
- Never index raw PDFs when a sibling markdown exists — PDFs are converted upstream. An orphan
.pdf blocks the run and requires user conversion.
- Never regenerate chapters outside the consolidated intent from 4.3 — delta discipline keeps diffs review-able.
- Never renumber existing chapters — append at the next free number.
- Never commit on the user's behalf — the final summary suggests a commit; the commit is the user's call.
- Never modify source documents (
docs/sprints/, docs/calls/, docs/requirements/, any Q2 path, any Q3 source). The dossier is a derived read-only artifact.
- Never switch language mid-version — the whole v1.(N+1) stays in the same working language as v1.N.
- Never invoke the bare
graphify CLI for indexing — never call graphify extract, graphify generate, graphify-cli, or any subcommand that performs LLM-driven semantic extraction. Those paths require a separate API key (ANTHROPIC_API_KEY / MOONSHOT_API_KEY / OPENAI_API_KEY / Bedrock / etc.) and bypass the IDE assistant's session. Always invoke the /graphify <path> slash skill instead, so the LLM-extraction step runs through the host AI's own model — no external key needed. If the slash skill isn't registered, Step 0.1 (Check B) must abort with a hint to run npx create-nonoise@latest --graphify-only. The bare CLI is allowed only for read-side ops (graphify query, graphify path, graphify explain) and the AST-only graphify update.
Known edge cases
| Scenario | Behavior |
|---|
| User says "full sync" in 4.3 | Re-index documents with --update, diff the graph, map all deltas to chapters, update every impacted chapter. Don't touch undelta-ed chapters. |
| Multiple document folders in Q2 | Index all, either unify graphs or leave separate — the sub-agents can read both. |
| Subject source graph missing and user doesn't want to wait | Offer to proceed without subject context — some chapters (the ones most dependent on source, e.g. data-model, internals) become read-only for this run. Warn explicitly. |
| A sub-agent in 5.2 fails or returns something suspicious | Log the error, restore the chapter to the previous version (git or pre-overwrite backup), mark it as "regeneration failed" in the CHANGELOG. Don't block the other chapters. |
| 4.3 intent is vague ("make it better") | Ask for clarification — don't guess on a task that writes many files. |
| User interrupts mid-run | No automatic rollback. Already-written chapters stay written. CHANGELOG is not updated until the end — if the interruption happens before Step 6.2, the dossier has an inconsistent state. User can re-run; the delta re-aligns. |
| Subject slug collision (two subjects want the same slug) | Reject — slugs are unique. Ask the user to pick a more specific one. |
First run ever (NEW in Q1) | Skip the current-version read (4.2), target v1.0, and use the 5.4 initial-spine path. |
| Project working language switches mid-session (shouldn't happen) | Stay in the dossier's current language. Warn the user that changing language requires a manual migration pass outside this skill. |
Support files
Related skills
arch-brainstorm — consumes the dossier as reference when planning new architectural worksprint-manifest — may reference the dossier in its "supporting docs" list for promoted PRDs
Final reminder on approach
This skill is an incremental orchestrator, not a one-shot generator. Regenerating from scratch every time destroys previously-reviewed work and produces unreadable diffs. The value of the skill is in:
- Reading the user's intent
- Identifying the minimum set of chapters to touch
- Dispatching targeted sub-agents that do surgical edits
- Tracking everything in the CHANGELOG
If you hit a case where the intent truly impacts every chapter (e.g. "we've completely reframed the subject because the domain shifted"), stop and propose either a manual pass or a major bump (v1.N → v2.0) that exits this skill's scope. Don't force M1 on a case that isn't M1.
