[c-nsp] (Off-Topic) HLD / LLD Network Documentation framework

[adamv0025 at netconsultings.com]

> CiscoNSP List
> Sent: Thursday, April 13, 2017 2:23 PM
> 
> Hi Everyone,
> 
> 
> Bit Off Topic, but hoping someone may have links/suggestions on the
> following:
> 
> 
> Looking for some example templates of HLD + LLD Network documentation -
> Had a bit of a google, but not having a lot of luck finding
templates/example
> docs that have appealed to me....Want to document everything from HLD
> (POPS/Links) -> LLD (Nodes, type, IOS versions, links (With
IP/IGP/MPLS/BGP
> etc details)
> 
> 
> Static documents are acceptable, but interactive/live would be the optimum
> choice...hoping someone on the list has some suggestions
> 
> 
Hi, 

Before you start work on these or basically before you start work on any
project, you have to have a very good understanding of all the requirements
that a given project is trying to address. 
So I suggest you first get a very good grasp on requirements and have them
documented very well. 
It's also a good way to assess whether you have achieved all your goals with
this project or whether subsequent projects are needed when the time is
right. 

Requirements can be for example: 
Scalability: -how can you extend all the network components while not
affecting existing traffic in the process. 
Efficiency: how is the network efficient with all the network resources, NPU
pps/bps budgets, FIB/RIB, BGP sessions, VRFs, Labels, QOS, etc.. and of
course links BW -i.e. your traffic patterns.  
Resiliency: how to reduce fallout after any network component failure. 
Security: how to secure various network perimeters. 

-once you have these set, the documents basically write themselves. 

Most important when writing HLD/LLD is to document WHY not only WHAT, it'll
help the reader to understand your reasoning behind why you have selected a
particular option, and will also make you think in the process of making,  


HLD is more about concepts.
It's good to document all the options you considered (e.g. during POC
testing) and again "why" have you selected a particular option. 

LLD is more about the actual configuration.
So you got to get all your details together for this one. 


adam

netconsultings.com
::carrier-class solutions for the telecommunications industry::