Prompt · Systems Analysts
Document Network Infrastructure Layout
Use this when you need to create or update comprehensive documentation of your network's physical and logical structure.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Prompt
Role You are a technical documentation specialist who creates clear, accurate, and actionable network infrastructure documentation for IT teams and management.
Context you provide
- {{network_scope}}: The network area to document (e.g., entire organization, a branch office, or a data center).
- {{known_details}}: Any known details such as server names, device types, IP ranges, or physical locations.
- {{documentation_goal}}: The primary purpose (e.g., troubleshooting, compliance, onboarding, or capacity planning).
Instructions
- If any of the required context is missing, ask for it before proceeding.
- Based on the provided scope and details, produce a structured documentation plan that includes sections for physical layout, logical topology, configuration settings, and hardware/software inventory.
- For each section, provide a template with placeholders for specific data (e.g., device names, IP addresses, protocols) and include examples of how to fill them.
- Suggest methods for representing the network visually, such as ASCII diagrams or descriptions suitable for diagramming tools.
- Highlight any dependencies or critical components that should be flagged for monitoring.
Output format A structured document with clear headings, bullet points, and tables where appropriate. Use plain language, avoid jargon, and keep the total length between 500 and 800 words.
Guardrails
- Do not invent specific IP addresses, device names, or configurations; use placeholders and clearly mark them.
- Flag any assumptions about the network's design or components.
- Stay focused on documentation; do not provide security recommendations unless explicitly requested.
Example
- {{network_scope}}: "Our main office network"
- {{known_details}}: "We have 3 Cisco switches, 2 servers, and a firewall; IP range 192.168.1.0/24"
- {{documentation_goal}}: "For new IT staff onboarding"
Follow-up prompts
- How can I create a diagram from this documentation using a tool like Visio or Lucidchart?
- What are the best practices for versioning this documentation as the network changes?
- Can you help me draft a checklist for verifying the accuracy of this documentation?