Start with a service record, not an unstructured document dump
Choose a service that your team supports and name its owner. Record what users are trying to do, where they connect from and which destination they need. Define a successful transaction so the operational outcome is clear before collecting device details.
Link the relevant inventory and diagrams to that service record. Give each document a scope and last-reviewed date. If the diagram and inventory disagree, record the conflict and assign an owner to resolve it instead of letting an AI answer silently choose one version.
The minimum useful documentation set
Use the fields below as a starting point. Include only information relevant to the service and investigation scope. Credential values belong in the approved credential-management system, not in prose documentation or example prompts.
| Record | Fields to include | Owner check |
|---|---|---|
| Service | Purpose, source sites, destination and success test | Application owner confirms expected behavior. |
| Network | Devices, roles, addressing, routing contexts and zones | Network owner checks the current design. |
| Dependencies | Primary and alternate paths, DNS and identity dependencies | Service and infrastructure owners review coverage. |
| Troubleshooting | Symptoms, initial checks, interpretation and escalation | Engineer validates procedure applicability. |
| Governance | Review date, approval requirements and document owner | Operational owner schedules maintenance. |
Example: document a branch-to-application flow
Illustrative record: the branch order workflow uses an application routing context separate from device management. The primary WAN path is preferred; the secondary circuit is a recovery path. DNS resolution and application authentication are required before a transaction can complete.
The associated troubleshooting note asks for the failing transaction, its timestamp, a working comparison location and current route and policy evidence. It explicitly states that management reachability is not an application acceptance test. Exact identifiers should be filled from your own verified inventory.
Prepare documentation for NetPrompt AI
Use the environment facts as Network Context and the diagnostic guidance as Network Troubleshooting Context. Keep terminology consistent across the two: a service name, site label or device alias should refer to the same thing everywhere. Add platform-specific details where they change command selection or output interpretation.
Start with a representative investigation and ask NetPrompt to identify assumptions and missing inputs. Review its explanation against the source material and live evidence. This provides a practical quality check before expanding documentation to additional services.
- Select one service and verify its owner.
- Reconcile names across inventory, diagrams and notes.
- Separate expected design from timestamped observations.
- State diagnostic interpretation and escalation rules.
- Test the context with a known incident and a healthy case.
- Refresh the record after approved design or procedure changes.
Keep the documentation useful after onboarding
Assign an owner and a review trigger to each record. A routing redesign, firewall policy change or service migration can invalidate the investigation context even when the document still looks complete. Link the review to the change process so updating the record has a clear operational owner.
Retain the previous rationale where it explains a decision, but label superseded details clearly. Keep unresolved gaps visible. A short, current service record is more useful during an incident than a large set of conflicting documents with no review status.
Common questions
- Do I need to document the entire network before starting?
- No. Begin with a representative service or site, make its scope explicit and validate that context. Expand as you confirm the records and workflows.
- Should I include live logs in the design document?
- Keep timestamped observations clearly separate from the expected design. A log excerpt describes a time-bound observation; it should not silently become a permanent statement about normal operation.
- Is the downloadable template a NetPrompt configuration import?
- No. It is an editable planning document for organizing your environment facts and troubleshooting guidance. Review and supply the relevant information through your configured NetPrompt workflow.
Continue exploring
Further technical reading
External references explain general practices; they are not endorsements of NetPrompt AI.