Doc Illustration
Use this skill to create polished illustrations for technical writing.
Quick workflow
- Identify the illustration type:
- architecture diagram
- process diagram
- knowledge card
- repo or module relationship diagram
- technical infographic
- Pick a style profile:
- default:
flat-tech-infographic - optional:
flat-illustration,sketchnote,soft-tech-diagram,repo-architecture-clean
- default:
- If the user supplied reference images, treat them as style guidance only.
- Prefer document-friendly landscape output unless the user requests another ratio.
- Prefer concise bilingual labels and short notes over paragraph-heavy copy.
- If the user wants to inspect the prompt first, use
--dry-run. - For live generation, run the bundled script.
Script
Use:
uv run scripts/generate_doc_illustration.py \
--title "RAG Pipeline Overview" \
--brief "Create a technical infographic showing ingestion, chunking, embedding, retrieval, reranking, and answer synthesis." \
--style-profile flat-tech-infographic
Use --mode reference+text --reference-image <path> when the new image should follow the style of one or more reference images.
Use --dry-run when the user wants the exact prompt and parameters without calling the API.
Default output settings:
--size autofor best compatibility with GPT image providers--quality autofor high-fidelity default behavior without over-constraining the request- use
--size doc-hdfor an explicit landscape document illustration size (1536x1024) - use
--size doc-2kfor a 2K landscape document illustration size (2048x1152) - use
--size doc-4kfor a 4K landscape document illustration size (3840x2160)
Authentication
- Read
OPENAI_API_KEYfrom the current shell first. - Read
OPENAI_BASE_URLfrom the current shell second. - If
OPENAI_API_KEYis missing for a live generation run, prompt temporarily in an interactive shell or tell the user to export the environment variable. - Do not write credentials to disk.
Model selection
- Use
gpt-image-2for official OpenAI and forhttps://aihubmix.com/v1. - Use
openai/gpt-image-2forhttps://api.ofox.ai/v1. - Default back to
gpt-image-2unless a provider requires a namespaced model name.
References
- Read
references/style-profiles.mdwhen selecting or explaining styles. - Read
references/prompt-patterns.mdwhen the requested illustration type needs prompt refinement. - Read
references/openai-image-workflow.mdwhen debugging auth, request modes, or output behavior. - Read
references/openai-official-links.mdwhen you need the official OpenAI docs for GPT Image, Images API, or Python examples.
