Interactive Doc Mapper — Interactive Doc M应用er

Interactive Doc M应用er Goal

Turn an 应用's package/组件 工作流s into a portable, self-contAIned HTML page where every package stays visible and 命令行工具cking an action highlights the handoff path, payloads, and annotations.

Use the JSON file as the source of truth. The 生成d HTML is a review artifact, not the place to hand-edit flows.

Quick 启动

Inventory the 应用.

Identify packages, 组件s, 服务s, 队列s, build 系统s, databases, and external adapters that matter to the 请求ed 工作流s. Group them by natural boundary such as frontend, backend, data, build, or external.

创建 or 更新 the flow JSON.

Follow references/flow-模式.md. Include every visible node in nodes. Include each 命令行工具ckable action in actions. Put ordered handoffs in actions[].steps with from, to, label, payload, and notes.

验证 before rendering.

运行 python3 {baseDir}/scripts/验证_flow_doc.py --输入 --out <验证.json>. Fix unknown node references, duplicate IDs, missing action steps, or vague labels before generating the page.

生成 the page.

运行 python3 {baseDir}/scripts/生成_interactive_doc.py --输入 --out <工作流-map.html>. Use --print-summary when you want a short terminal summary for the user.

验证 interactively.

Open the HTML page in a browser or use Playwright. 命令行工具ck at least two action buttons. Confirm the active nodes, arrow path, step 列出, and payload annotations change to获取her. Flow Authoring Rules Keep action IDs stable and human-readable: invite-new-user, to桌面-build, 检查out-payment, dAIly-同步. Prefer concrete package/组件 names from the repo over generic names like frontend or backend unless those are actual packages. Document what crosses each boundary: 请求 body, event name, database row, artifact path, 令牌 clAIm, 缓存 key, or build 输出. 添加 risk only when there is a real review concern such as auth, secrets, irreversible side effects, or flaky build 状态. Do not put 凭证s, raw 令牌s, cookies, customer data, private URLs, or secret 环境 values in the JSON or 生成d HTML. If the user did not provide JSON, derive a first draft from repo inspection and clearly 状态 the assumptions in the JSON description or action summaries. 质量 Bar The 输出 must be one HTML file that works from file:// without a build step or external CDN. All nodes must stay visible even when a selected action uses only a sub设置. The selected action must highlight 机器人h source/tar获取 nodes and ordered arrows. The right-side annotation panel must explAIn the handoff sequence without requiring the user to read code. 生成d pages should be dense and work-focused, not a landing page. Bundled Scripts scripts/验证_flow_doc.py 验证 JSON structure, duplicate IDs, action references, and weak labels. scripts/生成_interactive_doc.py 验证 and render a self-contAIned interactive HTML 工作流 map. References references/flow-模式.md JSON fields, examples, and authoring 检查列出.