Purpose
Implementation Plan Template (Reference)
Documentation for implementation-plan-template.md — a reusable template for writing network change implementation plans.
Purpose
This page documents the implementation plan template kept alongside it in this folder. The template is a copy of ~/implementation-plan-template.md, derived from the “Implementation Plan – PMRN Microwave Dedicated Interconnect Subnet V1.2” document, and is included here because it is a work-in-progress reference item rather than part of the production network documentation.
Design notes
- YAML frontmatter —
title,status(DRAFT → IN_REVIEW → APPROVED → COMPLETED / ROLLED-BACK),author,date_created,change_type,version, plus a comment block carrying AI-agent instructions (flag un-substituted placeholders; never invent values; no manual heading numbering). - Unnumbered headings — heading numbers are generated at export by
pandoc --number-sections, so deleting or reordering sections never breaks numbering (Word/LibreOffice auto-numbering behaviour, without the formatting overhead). - In-page cross-references — GitHub-style anchors (
[section](#slug)); links must be written after headings are final, because slugs are derived from heading text. - Personnel — named Change Controller and Escalation Contact fields, plus an on-site personnel table.
- Per-process structure — each
### [Process]has Description / Testing / Rollback / Result sub-sections, a> Duration:line, ⚠️ impact markers, and aResult — [Process]pass/fail gate;End of Changecarries the final gate and expected completion time. - Export —
pandoc -f gfm plan.md --number-sections --toc --toc-depth=3 -o plan.pdf(see the footer comment in the template).
All [bracketed placeholders] are meant to be replaced with project-specific content, and inapplicable sections are deleted.
Full template
The complete template file (implementation-plan-template.md) is reproduced below, unrendered:
---
title: "Implementation Plan: [Feature/Project Name]"
status: DRAFT # DRAFT, IN_REVIEW, APPROVED, COMPLETED, ROLLED-BACK
author: "@yourusername"
date_created: "[date]"
change_type: STANDARD # STANDARD, NORMAL, EMERGENCY
version: "[1.0.0]"
# AI agent instructions: flag un-completed [bracketed placeholders] before
# export; never invent values for them. Do not change status: without the
# author's explicit sign-off. Do not number headings — numbering is generated
# at export (pandoc --number-sections); for reviews, generate a numbered copy
# and reference sections by that numbering.
---
# Implementation Plan Template
> Template based on: "Implementation Plan – PMRN Microwave Dedicated Interconnect Subnet V1.2".
> Replace all `[bracketed placeholders]` with project-specific content. Delete any sections not applicable.
> **Do not add a manual Table of Contents** — every export target generates its own (see the TOC note below the Document Control section).
---
## Document Control
| Field | Details |
| -------------------- | ---------------- |
| **Customer Name** | [Customer name] |
| **Project Name** | [Project name] |
| **Document Name** | [Document title] |
| **Document Version** | [e.g. 1.0] |
### Sign-Off
| Role | Name | Date |
| --------------- | -------------- | ------------ |
| **Prepared By** | [Name] | [DD/MM/YYYY] |
| **Reviewed By** | [Name] | [DD/MM/YYYY] |
| **Approved By** | [Name] | [DD/MM/YYYY] |
> *Printed copies of this document are uncontrolled. Ensure you have the latest version.*
### Distribution List
| Copy No. | Recipient |
| -------- | ------------- |
| Master | Project file |
| 1 | [Recipient 1] |
| 2 | [Recipient 2] |
### Change History
| Version | Date | Name | Outline of Changes |
| ------- | ------------ | -------------- | -------------------- |
| 0.1 | [DD/MM/YYYY] | [Name] | First draft |
| 1.0 | [DD/MM/YYYY] | [Name] | Approved for release |
| 1.1 | [DD/MM/YYYY] | [Name] | [Change description] |
<!-- TOC: do not add a manual Table of Contents to this file.
- Customer PDF: generated at export — pandoc --toc (see footer).
- Confluence: use the built-in Table of Contents macro after pasting.
- Jira: no TOC — attach/link the PDF or Confluence page from the issue.
A static TOC in the markdown would render twice in the PDF and its
anchor links would be broken on Confluence.
Cross-references: link to headings with in-page anchors, e.g.
[the personnel section](#personnel). Slugs are GitHub-style
(lowercase, spaces -> hyphens; the export uses pandoc -f gfm).
Write a link only after its heading is final: a slug is derived
from the heading text, so renaming a placeholder heading (e.g.
[Process] -> Router Config) silently breaks any link to it.
Prefer links to stable headings; never link to headings that
repeat (GFM disambiguates repeats with a -1 suffix); list items
have no anchors, so step numbers stay as prose. -->
---
## Overview
[Brief description of the background and context for this change: what prompted the work, what existing design/condition exists, and what problem it causes.]
[Description of what this change will do, which devices/components are affected, and the expected outcome/benefit.]
## Outages and Hazardous Work
[State whether any outages to voice/data/radio/management traffic are expected during or as a result of this change.]
[List any services that will be briefly interrupted (e.g. monitoring and management of [systems] will occur during the [activity].).]
## Personnel
### Change Controller
- **Name:** []
- **Contact Number:** []
### Escalation Contact
- **Name:** []
- **Contact Number:** []
### On-site Personnel
To complete the scheduled work, personnel will be required at the following locations:
| Location | [Customer] | [Vendor] |
| ------------ | ------------------- | ------------------- |
| [Location 1] | Required / Optional | Required / Optional |
| [Location 2] | Required / Optional | Required / Optional |
## Implementation Steps
> Steps are numbered sequentially across all sub-sections. Checkboxes are reserved for verification steps — tick a checkbox only once the verification has been performed and passed.
> All steps to have a **Duration / Time** line ("T+00:00" is the start of the maintenance window).
> Mark any step with expected impact using: ⚠️ *Expected: [impact, e.g. access to device lost].*
### Preparation
1. **Confirm personnel on site**
2. **Go/No-Go decision from** [change controller]
> Duration: [00:00] — Time: [T+00:00]
### [Process]
> Duration: [00:00] — Time: [T+00:00]
#### [Description]
⚠️ *Expected: [transient impact, e.g. access to device lost].*
```text
[config commands]
```
#### Testing
```text
[test commands]
```
#### Rollback
> Duration: [00:00]
```text
[rollback commands]
```
#### Result — [Process]
- [ ] Failed — Rollback
- [ ] Passed — Proceed
### End of Change
> Expected Completion Time: [T+00:00]
#### Result — End of Change
- [ ] Rolled back
- [ ] Complete
## Configuration Excerpts
### [Device 1]
```text
[paste final configuration excerpt]
```
## Full Configuration
### [Device 1]
```text
[paste final configuration]
```
<!-- Export: render the final plan to PDF with a generated TOC:
pandoc -f gfm implementation-plan.md --number-sections --toc --toc-depth=3 -o implementation-plan.pdf
-f gfm is required so Pandoc generates the same anchors as GitHub /
VSCode previews, matching this file's cross-references; the default
slugger produces different slugs and silently breaks those links.
(VSCode: Markdown PDF extension with -f gfm and --toc in its args.) -->
Related
Source Disclaimer
- AI Generated
- Human Generated
- AI Edited
- Human Edited