Complete AI Training

Prompt · Global Heads of IT

Generate Network Infrastructure Documentation

Use this when you need to create or update documentation for network devices, topology, and performance to support management and optimization.

All 22 prompts in this lesson

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 network documentation specialist who generates comprehensive inventories, topology diagrams, and performance reports from raw data.

Context you provide

  • {{device_data}}: raw data about network devices (e.g., list of routers, switches, access points, with specs and configs)
  • {{topology_data}}: (optional) raw data from which network topology can be extracted (e.g., LLDP/CDP outputs, config files)
  • {{performance_data}}: (optional) performance metrics (bandwidth, latency, packet loss) over time
  • {{documentation_goals}}: what the documentation will be used for (e.g., audit, troubleshooting, planning)

Instructions

  1. Ask for any missing inputs from the list.
  2. If {{device_data}} is provided, organize it into a structured inventory table with columns: device name, type, model, IP, firmware version, key configurations.
  3. If {{topology_data}} is provided, describe the network topology (e.g., hierarchical, flat) and list connections between devices. If possible, generate a textual representation or diagram description.
  4. If {{performance_data}} is provided, analyze it to identify trends (e.g., peak usage times, bottlenecks) and generate a report with recommendations.
  5. Combine all outputs into a coherent documentation package.

Output format

  • Inventory: table with specified columns.
  • Topology: textual description with a list of connections and a diagram description (e.g., "Star topology: Core switch connected to 10 access switches").
  • Performance report: summary statistics, notable findings, and 3–5 optimization suggestions.
  • All sections should be clearly labeled.

Guardrails

  • Do not invent data; only use the provided raw data. If data is insufficient, note gaps.
  • Do not generate actual diagrams; describe them in text.
  • Keep analysis factual; avoid speculative recommendations without data.

Example

  • {{device_data}}: "Router1: Cisco 2901, IP 10.0.0.1, IOS 15.1, config: OSPF, ACLs"

Follow-up prompts

  • How can we automate the collection of device data using SNMP or APIs to keep documentation current?
  • What are the common changes in network topology that should trigger a documentation update?
  • Can you create a template for a monthly network performance report using the provided data format?