baoxi11/thesis-flowchart/thesis-flowchart

Thesis Flowchart

Core Approach

Create deterministic vector diagrams. Do not use generative image models for precise flowcharts. Default to editable SVG with a white background, black strokes, top-to-bottom layout, no internal figure title/number, and academic black-and-white styling.

Before drawing, read references/flowchart_standards.md. When the user wants a compact course-paper or undergraduate thesis style, also read references/local_html_reference_style.md. For final checks or PNG/PDF delivery, read references/export_checklist.md.

Information To Gather

If the request lacks enough process logic, ask only for the missing essentials:

• Flowchart name and thesis use.
• Complete ordered steps.
• Decision nodes and their conditions.
• Each decision's yes/no branch targets.
• Loops, subprocesses, or parallel steps.
• Vertical or horizontal layout preference.
• Thesis page width, single-column/double-column requirement, or target size.
• Required output formats: SVG by default; PNG/PDF on request.
• School rules for font size, line width, color, and captions.

If the user does not specify typography, state the default font size used. Use a consistent size across the chart.

Workflow

1. Extract start, end, inputs, outputs, process nodes, decision nodes, subprocesses, branches, loops, and inferred links from the user's text.
2. Stop and ask when branch logic is incomplete, ordering is ambiguous, or a decision lacks yes/no outcomes.
3. Draft a structured flow list before rendering. Keep user-provided terms, variables, algorithms, and module names unchanged unless a typo is obvious.
4. Encode the flow as JSON using scripts/generate_flowchart.py's schema.
5. Generate SVG first:

python scripts/generate_flowchart.py --spec examples/zh/simple_research.json --out out/simple_research.svg

1. Validate the structured flow and SVG:

python scripts/validate_flowchart.py --spec examples/zh/simple_research.json --svg out/simple_research.svg

1. Render or inspect a preview. Fix overflow, cropped text, overlaps, line crossings, ambiguous arrows, wrong symbols, and font warnings before delivery.
2. Export PNG or PDF only after the SVG passes validation:

python scripts/generate_flowchart.py --spec examples/zh/simple_research.json --out out/simple_research.png --format png --dpi 300
python scripts/generate_flowchart.py --spec examples/zh/simple_research.json --out out/simple_research.pdf --format pdf

PNG/PDF export uses Inkscape or CairoSVG when available. If those are unavailable, the script can fall back to Pillow for PNG or ReportLab for PDF when installed. Re-open the output to verify it before delivery.

JSON Source Pattern

Use clear ASCII file names without spaces. Keep the JSON source as the editable source file when no richer source format is needed.

{
  "title": "algorithm_flow",
  "orientation": "vertical",
  "font_size_pt": 10.5,
  "nodes": [
    {"id": "start", "type": "start", "label": "Start"},
    {"id": "step1", "type": "process", "label": "Read experimental data"},
    {"id": "ok", "type": "decision", "label": "Data valid?"},
    {"id": "end", "type": "end", "label": "End"}
  ],
  "edges": [
    {"from": "start", "to": "step1"},
    {"from": "step1", "to": "ok"},
    {"from": "ok", "to": "end", "label": "yes"},
    {"from": "ok", "to": "step1", "label": "no", "kind": "loop"}
  ]
}

Allowed node types: start, end, process, decision, subprocess, io.

Delivery

After completing a chart, provide:

• The final flowchart file path.
• A visual preview when possible.
• Page orientation, font size, and output format.
• The editable JSON source file when generated.
• Any assumptions made about missing process logic.
• Any unresolved logic issues that need confirmation.

Run tests after script changes:

python scripts/test_flowchart_scripts.py
python scripts/run_examples.py