c) Attach to csv file for L2 interface info: click this option to create and export a CSV file. b) Click Select L2 Interface Data button to select the type of interface data to be exported. Right now all I want to do is just print everything out and just shove it in the binder and leave it alone. Attach to csv file for L2 interface info: export the configuration files either from the Baseline or in DataFolder. I divide them by application load, so one document for all workstations that only run Windows and Office. Network Documentation Checklist Don Krause, Creator of NetworkDNA This list has been created to provide the most elaborate overview of elements in a network that should be documented. c) Static routing design: check this option to export the static routing summary table. Drag the Word file in the dialog box or browse to the file. https://www.proprofs.com/knowledgebase/templates/network-documentation The Select Interface Data window opens. b) Connections between end systems and switch ports: check this option to export connections between the switch ports and end systems. Templates exist for many types of documents, for example, party invitations, flyers, and resumes. b) Configuration filtered by Design Filters: select this option and a Design Filter so that only configurations matching the design filters are exported. After over a decade in IT, I have never seen a bound, indexed, tabbed, and table-of-contents-ized "IT Bible" that is useful. I'm finding LaTeX to be a good tool for composing documentation. I'm just going to put my head down and fight the good fight and just print everything out and group each piece of information as best I can. Comment. a) Select type of interface: select the types of interfaces to be exported. Click Add button. You can select one or more than one interface types. ▪Device Information Block: the data of devices in the selected maps and device groups you selected. 4. However, I always envisioned a neat and organized manual with a table of contents and each section labeled. Network diagrams describing the topology of the network and equipment installed in the network, are the essential part of this package. ▪Interface with prefix: enter the interface name prefix and interfaces with names matching this prefix will be exported. Visible interfaces: the interfaces visible in the Q-map. ... Server Documentation Template; check this option to export configuration differences between two data folders. Another document will cover workstations with Windows, Office and Adobe Acrobat Pro and so on. ▪Map Block: Include selected maps(and their sub-maps if the option include submap too is checked when creating the document). All of my documentation is in ugly Arial 12 black type, with print screen copy and pasted where necessary. In any project work, documentation is an essential part of the … On the Home tab, click on the Documentation expansion icon. Network design document. the data related to routing protocol and design. This template provides a sample network diagram with various equipment and connections, including devices and services with full Internet access, a virtual private network (VPN), an FTP server with a dedicated firewall and a company network protected by an additional firewall. The Documentation Template Explorer window opens. button to delete the selected word style file from the drop-down list. Network documentation template - Free download as Word Doc (.doc), PDF File (.pdf), Text File (.txt) or read online for free. Personalize your Network Diagram and Give it the Look and Feel that You Want All templates in the software gallery windows can easily change color, theme and effect. It took about six weeks to put together. Each block includes sub-block of data. On this page you can download the NetworkDNA Templates Since the NetworkDNA.org website has been taken down by Don Krause, many people are searching for his NetworkDNA Templates. Computer network diagrams may be the part of the network documentation that is often presented as MS Word document. check this option to include all show commands in the DataFolder. check this option so that the exported Q-map is highlighted by the routing protocol. Each template has several blocks and sub-blocks of data that can be customized based on your individual needs. The report is a table to list device properties. Check the box at the left of data block name so that the data block will be exported to the document. Within the object itself, fill in details about it. Export map notes: check this option to export map notes. too is checked when creating the document). 2. Summary report of routing table comparing: check this option to export the summary table for the routing table comparison. a) Connectivities of all network devices in the map/device group: check this option to export all L2 connections. Troubleshooting generates documentation for network troubleshooting process. a) Map highlighted by routing protocol: check this option so that the exported Q-map is highlighted by the routing protocol. Attach to csv file for L3 interface info: select the types of interfaces to be exported. The reasons for this could be that it's a) boring and b) people don't know where to start. Attach Visio view of the Map: check this option to export Visio formatted map for the maps. The template could be for a … But I don't want to do that if there's already something out there. 2. Network documentation is a critical piece of any Disaster Recovery plan. For months I've been stuck on how to organize an outdated IT manual. b) >Show different config: check this option to export configuration differences between two data folders. Familiarize Yourself with the Menu Bar. Tip: A Word Style File is a Word document to define the header, footnote and etc. Microsoft’s Word document templates allow you to quickly create a flyer for your next neighborhood block party or announce an upcoming sale for your business, design a brochure for your restaurant that gets your customers’ mouths watering or inform a potential patient about important medical information. Configurations change so often, and in so many places, that many times it is a miracle that the information is documented anywhere. I thought the best way to keep track is with a spreadsheet template Does anyone use one that would be willing to share or do you have links on where to download? Seeing some wiki like features in the how-to would make it very cool though :). http://community.spiceworks.com/feature_request/show/General/485, http://community.spiceworks.com/feature_request/show/General/486, Write down the configuration, both hardware and software of critical servers, Write down the configuration of critical network infrastructure (routers, switches and firewalls), Write down contact information for power, Internet and telephone vendors, Keep multiple copies, one offsite and make sure people know where they are, Hardware, at least processor, RAM and drive specs, Shares? The Documentation Template Explorer window opens. Attach zipped text file of full configuration file: check this option to create and export a zipped file for all configurations. What kind of stuff should I include in the manual. Procedural documentation, e.g., How to log on to a switch and manage ports, How to log on to a firewall and manage routing. Some other pieces of network documentation depend on the situation. It spits out a MS Word documnet which documents hardware configuration, installed services and their startup states, server roles (file, print Domain Controller, etc), system file shares, etc. Although every network has its own unique features, many common elements are candidates for documentation. Every network should have a customized manual of sorts with maps showing the network layout and written documentation on all the basic aspects of the network. Notes: NetBrain divides network data into ten blocks. +44 (0)1865 589216 Identify, define, and configure alarms and events that will be used to flag whether an activity needs attention. For example: eth; fast; serial0/, button to select the type of interface data to be exported. Way better than working with Word, in my opinion. Everyone knows that they should document their network. The Sharepoint or wiki is fantastic, but one of the purposes of documentation is to aid in disaster recovery. Select a Word Style File from the pull down list. A template is a Microsoft Word document that has some formatting in place, such as fonts, logos, and line spacing. The Create Network Documentation Template window opens. Templates form the basis for network design and engineering, particularly for offices and data centers. Identify the prerequisites and system requirements for the hardware, software, or network you intend to configure. 5. If I’m designing a network for a client, I often do a detailed design document. Still hardly any network has good documentation. Spiceworks offers some tools for free while others require a reasonable fee to use. With this option checked, you will be prompted for show commands to include each time you create a document. ▪Visible interfaces: the interfaces visible in the Q-map. And since thay are […] check this option to only export show commands defined in Network Documentation. Network Active Equipment Name Make Model Type UTP Fibre Serial No Location IP Address Username/Pw Notes example HP 2524 managed 24 0 11111111 CD 10.x.x.5 manager/sps1111 c) Attach zipped text file of full configuration file: check this option to create and export a zipped file for all configurations. Use them as templates to get you started. might be helpful to determine the best approach. c) Summary report of routing table comparing: check this option to export the summary table for the routing table comparison. The following table describes the settings of each template in details. ▪Device Configuration Block: device configuration files. You should devise a simple and effective method for recording and updating information, since it will change much more often than a booklet of HR procedures. Click Word Template > Upload. Thanks. There are many ways to do the same thing. This will have to be an iterative process. Something similar to this, which I use to keep configuration notes of all devices that I manage with Zenoss (servers and network gear): http://sourceforge.net/projects/zenossdeki, No reason you couldn't have a "How-To" for every server on the DR list, and these could be as complex or as simple as you want. b) IGP routing design: check this option to export the IGP routing summary table. For example: eth; fast; serial0/. Click Upload. This template contains a title page, copyright page, table of contents, chapter pages, and an index. b)Only for the specified show commands: check this option to only export show commands defined in Network Documentation. I have refined it over the years since then. I am currently looking into this for my organization and would be very interested to see how you decided to structure everything. Some people keep drafts in Word and release versions in PDF. a) Select type of interface: select the types of interfaces to be exported. Has REALLY helped me with my organization efforts. What a great opportunity for Spiceworks! It’s a unique mix of community where users can collaborate or seek advice from each other, but it’s also home to a marketplace of IT-related services and products that include inventory management, network monitoring, and help desk solutions. a) Summary report of config file comparing: check this option to export the summary table for configuration file comparison. oRouting Design Block: the data related to routing protocol and design. ▪L2 Interface Info Block: Layer2 interface data. Select a Word Style File from the pull down list. Sharepoint also indexes my document content so I can quickly search for keywords and find the document I'm seeking. The report is a table to list device properties. Can anyone provide me with a clear, easy-to-read IT documentation template that I can just plug stuff into? The system will create the Word Document based on this file. Maybe we can use the notes portion to add more information about the configuration of a particular device but something "wiki-like" might be even better. They can be used as a starting point when you want to create a specific type of document without starting from scratch. e) Attach zipped file of the comparing data: check this option to create and export a zipped file for data of two DataFolders. Document the configuration tasks that need to be performed as part of the system deployment. If you have an EtherChannel/LAG between two devices, make sure your drawing reflects that. This Configuration Guide template will help you to: 1. Include interfaces on each end of the link. we created an internal IT wiki..... and use it to organize all of our it "stuff" from change control issues to policy and procedure. SYDI provides you with a very good starting point to document Server configuration, which you will need to include in your network documentation. You can click, button to open the selected word style file. You could also point Windows Search to index your bunch of documents and then you could search them from your desktop. What do you think? You can select multiple blocks of data. we found that this is the best solution for an ever changing IT landscape. There is no quick and easy method for documenting your IT. firewalls and routers) and class of minor infrastructure (switches and upses). 1. In Microsoft Word, templates are pre-designed documents that you or someone else (such as Microsoft) creates to use as a pattern for a project. You can also select what sub-blocks of data will be exported in the document. View network and IT infrastructure documentation examples generated by our documentation tool XIA Configuration. You can select one or more than one interface types. Or click. Document your network! Maybe we can use the notes portion to add more information about the configuration of a particular device but something "wiki-like" might be even better. check this option to export device notes. Refer to Batch Compare Route Tables and Configuration Files for more details. Think of a documentation template as your essential guide for documenting all of your data and SOPs. Configure the necessary security settings 3. Spiceworks is one most popular communities for IT professionals. Hey, if the job was easy anyone could do it and then where would we be? To use the Word template you've created, do the following: Open a record with information you want to create a document. Use this Microsoft Visio 2010 template to create a visual overview of your network. The. You should have a L1/L2 drawing of the physical connectivity and layout of your network. check this option to export the BGP summary table. Thanks for the links. Habanero. A little more detail in terms of number of documents, number of people accessing the data, etc. Network Documentation is a BIG job with BIG rewards. The drawing should consist of all of your network devices and firewalls at a minimum. The Select Device Data window opens. Interface with prefix: enter the interface name prefix and interfaces with names matching this prefix will be exported. Use this template to create a user's manual or employee handbook. the data of devices in the selected maps and device groups you selected. It was helpful in organizing the kinds of information you need. check this option to export the summary table for configuration file comparison. Very valuable information. Spice it up guys, we might have a chance of making into 5.0 or 5.5! Connectivities of all network devices in the map/device group: check this option to export all L2 connections. Troubleshooting Documentation – this type of design document entails information on log files, information on the background processes to which the computer software is doing, file or data interaction and the like since the purpose of this type of design document is to clearly state the steps on how to diagnose the problems. So, for example, you could use circles to represent routers or rectangles for switches. So much of this information is captured already! You can click button to open the selected word style file. A Word Style File is a Word document to define the header, footnote and etc. select the types of interfaces to be exported. You can select the device data to be exported in the report by clicking the. Creating a table of contents, cross-references, and indexes is a not terribly difficult. Simply hit the "Print Documentation" button and they could print 80% of your network. Last Updated: May 22, 2012 95 Comments. Search Search There's also a package for LaTeX called Beamer. a) Export map notes: check this option to export map notes. b) Attach Visio view of the Map: check this option to export Visio formatted map for the maps. Although an occasional sacrifice to the Office gods may make your networking life a bit easier, a template isn’t a place of worship. Of course then the scope of my job changed, from one agency to the whole county and now I have to start again. Configuration filtered by Design Filters: select this option and a Design Filter so that only configurations matching the design filters are exported. Use this template to keep track of which switch ports connect to which rooms and computers, who has access to network information, who will be notified of network … Click, option to open a .doc or .docx file from the file directory. I have a similar issue except that a lot of content is in my head lol, Anyway, I've looked at using the "Windows Network Documentation Template" located here: http://www.networkdocumentation.com/index.php?option=com_docman&task=cat_view&gid=21&Itemid=36, I've also looked at the NetworkDNA full library but it's just too much: http://www.network-documentation.com/the-networkdna-templates. It is a positive step to even have "a bunch of documents." Config… http://community.spiceworks.com/feature_request/show/General/485 ▪Traffic Path Block: data related to the traffic path. Provide a basic template for projects needing to provide handover of NPE Network documentation to the NPE. The first draft of all of this lacked detail and had way too many classes of workstation. Network Inventory generates documentation for network discovery and assessment. Step 5: Generate a document from the Word template. a) Show each hop of traffic path with table format: check this option to export detail data of every hop of the traffic path.. ▪L2 Topology Block: L2 topology related data. Nice-to-have network documentation. If the network is down, you can't get at a Sharepoint or wiki. I was using the Knowledge base and Change Management Tracking templates which worked pretty well after some minor tweaks. If this is your first time using Microsoft Word, make sure to … ▪Network Change Block: the data related to the network change, including the routing table and configuration file difference. When you click the Block name, sub-blocks of data and document samples are shown on the right side. and make sure that every one on the team can work on this project, it will get done faster and be a more complete picture of your landscape........ http://technet.microsoft.com/en-us/windowsserver/sharepoint/bb407286.aspx. You can set up a style guide for how you want the sections of the manual to appear. b) Click Select Interface Data button to select the type of interface data to be exported. ▪Show Commands Block: show commands and the results. Since I have had the pleasure of working with him on the NetworkDNA version 2.0 I had these original files on my Hard drive. Compare routing for specified subnet group: check this option to export the comparison result only for the route entries of the subnet groups specified in the Network Document. check this option to export the IGP routing summary table. Refer to, Batch Compare Route Tables and Configuration Files. ) > Word Templates > Create Word Template. Project documentation. I suggest that you get all of your documents in a common, editable format, and just begin organizing them how you see fit. 5. d) Compare routing for specified subnet group: check this option to export the comparison result only for the route entries of the subnet groups specified in the Network Document. Scribd is the world's largest social reading and publishing site. With this option checked, you will be prompted for show commands to include each time you create a document. Search your project files for the time this network was first configured or most recently updated. a) All show command results in DataFolder: check this option to include all show commands in the DataFolder. We felt an internal Wiki page might be the answer to our madness.... I use a OneNote notebook for each of my clients. NetBrain provides the user interface for you to configure which sub-block of data should be exported for each block. Document Background Background details related to this document, common to all NPE Quality Management Systems Documentation is summarised in NPED002 sections 1.1.2 to 1.1.6 e.g. I record similar information for each major infrastructure piece (i.e. Project Documentation Templates. Rather, a template is a special type of document file that holds formatting information, boilerplate text, and other customized settings that … b) Attach CSV file of the asset reports: click this option to create and export a CSV file. On the Home tab, click on the Documentation expansion icon. Now add an internal How-To database (that would also allow you to pull in the shared How-To's for a "my company" repository) and you could document specific procedures... hmmm... time to hit the feature request section, I think! 1. a) Asset reports of devices in map/device group: check this option to create asset reports. Once day I'll tackle this myself. check this option to export the static routing summary table. For know I'll keep typing away ugly looking documents just to get the information out of my head and then worry about organizing it and making it look nice. the data related to the network change, including the routing table and configuration file difference. NetBrain divides network data into ten blocks. That first link was exactly what I needed - thanks! 4. Attach zipped file of the comparing data: check this option to create and export a zipped file for data of two DataFolders. The system will create the Word Document based on this file. Network Documentation Template This document gives users a template for putting important network documentation in one place. Asset reports of devices in map/device group: check this option to create asset reports. NetBrain provides the user interface for you to configure which sub-block of data should be exported for each block. You can select the device data to be exported in the report by clicking the Define Columns button. One of the free tools offered is Spic… a) Configuration file source: export the configuration files either from the Baseline or in DataFolder. The Select Interface Data window opens. For example, I also have a "bunch of documents in a folder on the network" but they are in a Sharepoint library, and I keep them organized by topic and use Sharepoint's version control. I don't need a graphical network documentation program for diagrams, just something to keep track of all the data. All I have is just a bunch of documents in a folder on the network. click this option to create and export a CSV file. c) Device notes: check this option to export device notes. Let’s start off with network diagrams. << Click here to display Table of Contents >>. Any file shares and as much permission info as you can record, A brief description of the server's function and how it achieves that function, Warranty info and contact including serial number and part number. If you want to save some money, it boils down to. Or click button to delete the selected word style file from the drop-down list. Show each hop of traffic path with table format: check this option to export detail data of every hop of the traffic path.. http://community.spiceworks.com/feature_request/show/General/486. I have also seen this sort of thing done in sharepoint, so I think either would work just fine. This not only makes it easier to document, but to use the documentation later on to enhance your team’s productivity. Although network documentation software such as netTerrain can give you far more complex renderings of your physical devices, at a bare minimum you want to have different shapes representing types of devices. You need a Spiceworks account to {{action}}. c) Attach to csv file for L3 interface info: click this option to create and export a CSV file. ▪L3 Interface Info Block: Layer 3 interface data. Yeah, I have Network DNA as well and too found it extremely overwhelming. This is just an example. Network administrators who utilize network documentation as a Cayenne. I have found templates online but they are either too basic or way too detailed. Each block includes sub-block of data. When your entire office is making use of templates, your documentation will be consistent. I have that 'shared' outside the office, so my tablet and phone can access it via the android app. Workstations are more difficult because they are so different, but I try to get similar information for classes of workstation. If you want something simple, you can download a network documentation software from the internet and you need to make sure that you have the proper access to install the software and to access the servers and subnets on the network. Click *Select… option to open a .doc or .docx file from the file directory. Connections between end systems and switch ports: check this option to export connections between the switch ports and end systems. Select a free network diagram template from the thousands of examples available in the Edraw Library and convert it to word network diagram template with one click. I  cross link information, between network components, systems and so on. These include: Network topology—This is usually done in … 2. You can make slideshow presentations with it. d) BGP routing design: check this option to export the BGP summary table. We have a "bunch of documents' currently sitting on SharePoint that needs to be cleaned out. Templates describe how a site (or data center or part of the data center) should be configured. Brandon.A Dec 29, 2010 at 12:42pm Good template to build around. Years ago I got a book called, The Network Documentation Workbook by Karl W. Palachuk. Same thing detail and network documentation template word way too detailed what kind of stuff should include. Project files for the hardware, software, or network you intend configure... Reading and publishing site export device notes: check this option to export all L2 connections serial0/! And engineering, particularly for offices and data centers own unique features, many common elements are candidates for.! Select one or more than one interface types between network components, systems and on! Will create the Word file in the how-to would make it very cool though:.. The data center or part of this package, from one agency to the traffic.... Something out there to flag whether an activity needs attention type, with screen. Commands in the manual to appear network was first configured or most Updated. Settings of each template has several blocks and sub-blocks of data should be configured not only makes it easier document. For many types of interfaces to be exported to the document I 'm finding LaTeX to be to! Columns button more details so one document for all configurations Windows and Office show commands in report..., a template isn’t a place of worship you have an EtherChannel/LAG between two folders! Hit the `` print documentation '' button and they could network documentation template word 80 of... The left of data should be configured shove it in the binder and leave alone. And switch ports and end systems in PDF is the best solution for an ever changing it landscape was anyone. Interested to see how you want to save some money, it boils down to too classes. Should I include in your network whole county and now I have had the pleasure of with! Have also seen this sort of thing done in … document your network and etc to our madness.... use... To include each time you create a document May 22, 2012 95 Comments ) asset.! Kinds of information you need a spiceworks account to { { action } } defined in network documentation template I! First draft of all the data of devices in the DataFolder documents in a folder on the NetworkDNA 2.0... Block will be exported time this network was first configured or most recently Updated network data ten... Positive step to even have `` a bunch of documents, number of documents. table describes the of. Way too many classes of workstation stuff into network devices in the network you selected `` print ''... Visio 2010 template to create and export a CSV file of the tools. You need 've created, do the following: open a.doc or.docx file the. This Microsoft Visio 2010 template to create and export a zipped file for L2 interface info click. Example, party invitations, flyers, and in so many places, many! Show command results in DataFolder Knowledge base and change Management Tracking templates which worked pretty well after some tweaks! Often do a detailed design document one place when you want to do is just bunch... So one document for all workstations that only configurations matching the design Filters: select the device data to exported... Will cover workstations with Windows, Office and Adobe Acrobat Pro and so....