{
 "schema_version": 1,
 "generated": "2026-10-20",
 "id": "weike-zhang-architecture-canvas--requirements-doc-to-editable-architecture-diagram",
 "repo": "weike-zhang/architecture-canvas",
 "repo_url": "https://github.com/weike-zhang/architecture-canvas",
 "repo_slug": "weike-zhang-architecture-canvas",
 "title": "Turn a requirements document into an editable architecture diagram",
 "page_title": "How to turn a requirements document into an editable architecture diagram with Architecture Canvas",
 "summary": "Upload a spec, let the assistant draft a diagram, then refine it by chat and export SVG or PNG.",
 "who": "A tech lead or architect who has a requirements document, spreadsheet, or PDF and needs a first architecture diagram to discuss with the team.",
 "problem": "Drawing the first architecture diagram from a long spec by hand is slow, and each change request means redrawing parts of it.",
 "outcome": "An editable architecture diagram generated from your uploaded materials, with later changes proposed, confirmed, and kept in the same canvas, exported as SVG or PNG.",
 "steps": [
  "Run `git clone https://github.com/weike-zhang/architecture-canvas.git` and then `cd architecture-canvas`.",
  "Run `python3 start.py` and open http://127.0.0.1:5093 in your browser.",
  "Click 模型设置 in the lower left corner and enter a tool-calling model URL, model name, and API key.",
  "Upload your requirements file (TXT, Markdown, DOCX, XLSX, PPTX, or PDF) and ask the assistant to draft the architecture.",
  "Review the proposed changes, click 应用修改 to apply them, drag or edit nodes on the canvas, then export SVG or PNG."
 ],
 "agent_prompt": "Using the architecture-canvas repo at https://github.com/weike-zhang/architecture-canvas, start the local workspace with python3 start.py, upload the document at <path-to-requirements-doc>, and ask the assistant to generate a layered architecture diagram. Expected output: an exported SVG or PNG of the diagram. Verify that the component count is 22 or fewer and that the component list matches the document.",
 "agents": [
  "any"
 ],
 "difficulty": "Intermediate",
 "time": "60 minutes",
 "basis": "readme",
 "caveat": "Generation is limited to layered architecture, business module, and simple deployment overviews, usually 22 components or fewer, and the README says model output needs manual review.",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "python",
 "requirements": [
  "Python 3.10+, Node.js 22.12+, and npm installed on your machine",
  "A model service with a Chat Completions compatible API that supports tool calling, plus its API key, for chat, generation, and document understanding",
  "A vision-capable model if you want to send images to the assistant"
 ],
 "risk": "sensitive",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [
  {
   "tag": "credentials",
   "notice": "The API key you enter is kept only in server memory, but uploaded files, read file snippets, and the architecture structure are sent to the model service you configure, so do not upload confidential material to a service you have not approved."
  }
 ],
 "best": true,
 "score": 1.0,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/weike-zhang-architecture-canvas/requirements-doc-to-editable-architecture-diagram/",
 "md": "https://dedupedai.com/use-cases/weike-zhang-architecture-canvas/requirements-doc-to-editable-architecture-diagram/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/weike-zhang-architecture-canvas--requirements-doc-to-editable-architecture-diagram.json",
 "api_version": "v1"
}