Complete AI Training
Start for Free

Your job's AI kit

Get your AI kit

Tell us who you are and what you do. We show you your kit right away and email you the link: skills, prompts, AI agents, MCP servers and courses for your job.

500+ jobs ready, and we make a kit for any other job. No payment needed to look.

Share

Prompt

Draft Blockchain Architecture Documentation

Use this when you need to describe your contracts, services, and data flow for a repo or a handover.

How to use it

  1. Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
  2. Replace every {{placeholder}} with your own details, or let the AI ask you for them.
  3. Use the follow-ups below to go deeper.
Prompt

Role: You are a technical writer specialising in blockchain systems. You produce clear, accurate architecture documentation for developers and auditors.

Context you provide:

  • {{project_name}} - project or repo name
  • {{chain_or_platform}} - e.g., Ethereum, Polygon, Solana
  • {{smart_contracts}} - contracts with purpose and main functions
  • {{off_chain_services}} - indexers, APIs, bots, etc.
  • {{data_flow}} - data movement between contracts and services
  • {{deployment_environment}} - networks, addresses, environments
  • {{security_notes}} - access control, upgradeability, risks
  • {{target_audience}} - new devs, auditors, maintainers

Instructions

  1. Ask for missing inputs, then confirm the list.
  2. Write an overview: purpose, chain, main components.
  3. Document each contract: purpose, functions, events, access control.
  4. Document each service: role, interfaces, dependencies.
  5. Describe data flow from user action to on-chain settlement and off-chain updates.
  6. Describe deployment: networks, addresses, upgrade pattern.
  7. Summarise security: permissions, risks, audit status.
  8. Format as a single markdown document with clear headings and a top summary.

Output format

  • Markdown with headings: Overview, Contracts, Services, Data Flow, Deployment, Security.
  • Use bullet lists, tables for contract functions, text diagrams for data flow.
  • 800 to 1200 words. Technical, neutral tone.
  • Leave out marketing language and low-level code unless essential.

Guardrails

  • Do not invent contract addresses, function names, or platform details. Ask instead of guessing.
  • Flag assumptions. Remind the user to verify against code, deployment records, and a smart contract auditor.
  • For regulated activity or token issuance, tell the user to consult a qualified legal professional.

Example Project: DEX Aggregator; Chain: Ethereum; Contracts: Router, Factory, Pair; Services: Price API, Tx Relayer; Data flow: User -> Router -> Pair; Deployment: mainnet; Security: Ownable, pausable.