How to write the documentary for entire IT system

In the IT infrastructure, you have some documentary for management, planning as well as inventory for IT audit. these documents are usefull for handing over or taking over from this person to another person. and also keep monitoring well on your system day by day, and support upgrading your system in future as well.
So today I would like to introduce 03 index of document which you often have in our IT system, those are:

A. Network Design Document
B. Infrastructure Desing Document
C. Telecom Design Document
D. IT System Document (update later)
E. Database Admin Document (update later)

In my opinion, how to write the documentary for entire IT system, it is not easy for begginer and you don't know where is starting point. Today I want to share some my experience to how you write these documents at my company. I just want to show some tips which I spent a lot time to do it. I hope it is usefull for you.

First thing, you remember that all of these document information maybe you don't know them details and exactly, so you don't worry, at least you can immage that what it is, for example such as Telecom system or IP PBX system, you need to realiaze what ACD is, that is automatic call distribution system, and you understand that their operation is based on two tables, those are incomming call table and outgoing call table, and that's all.

Second thing, if you are good at technology, you manage and control your system well, but you don't know how to wirte a summary of document for your undercontrol system. I think that first job is you need to define one table of contents of that document. Maybe having a little difficulty for you to write it, so I shared it on the internet on my own blog, you can refer to these for index of these document. I hope you get a little information.

So next I want to mention to last thing, now you completed to design a layout of document. next step you need to input all information on it. It is not easy for you if you are begginer. I think we have 02 important points at here. First point, you need to use some utilized function in a document such as table, graph and charts, in my document I use a lot of tables to input all information. and second point that is when you write somethings, it will has two aspects those are logical and physical feature. For example as logical network diagram and physical network diagram.

Now I finish at here, I hope it useful for some person or begginer to write these document. you can handle your system well if you have a good document. thank you for your time to read it.

P/S: my english is not good. maybe have some misstakes when I write it.

A. Network Design Document

Table of Contents
CHAPTER 1. MANAGEMENT SUMMARY.
1.1 How this document is organized.
1.2 Conventions.
CHAPTER 2. NETWORK OVERVIEW FOR SUPPORT.
2.1 Primary Data Center network (PDC)
2.2 Disaster Data Center network (DRC)
2.3 Branches network (BO)
2.4 External connections (POS)
CHAPTER 3. LOGICAL NETWORK DESIGN.
3.1 Logical Network Module.
3.1.1 Core Module:
3.1.2 Access Module:
3.1.3... Infrastructure Module
3.1.4... Management Module
3.1.5 Internet Module
3.1.6 DMZ module
3.1.7 WAN Module
3.1.8 Voice Module
3.2 VLAN Topology.
3.3 IP Addressing Range.
3.3.1 End User IP Subnets
3.3.2 Voice IP Subnet
3.3.3 Server IP Subnet
3.3.4... Equipment IP Subnet
3.3.5... DMZ1 and DMZ2 IP Subnets
3.3.6... Meeting room IP Subnets
3.3.7... Management IP Subnets
3.3.8... Internet Access IP Subnets
3.3.9... Switch’s Management IP Subnets
3.4 DNS Name/Device Host Name.
3.5 EtherChannel:
3.6 Per-VLAN Spanning Tree (PVST)
3.7 Host Standby Routing Protocol
3.8 IP Routing.
3.8.1... Default Routing and Static Routing
3.8.2 RIP routing
3.8.3 OSPF routing
3.9 Generic Routing Encapsulation (GRE) Tunnel
3.10 IP SLAs Operations - Reliable Static Routing Backup Using Object Tracking.
3.11 Logical Network Diagram.
Chapter 4. Physical Network Design.
4.1 Cabling and Rack/Floor/Building Infrastructure.
4.2 Device Names and Locations:
4.3 Device Hardware Configuration:
4.3.1... Cisco Router VNPDC-IET2821R-1
4.3.2... Cisco Router VNHQ-IAT3845R-1
4.3.3... Cisco Switch VNHQ-CD4506-1A
4.3.4... Cisco Switch VNHQ-CD4506-2B
4.3.5... Cisco Switch VNHQ-DMZ1-2960-1
4.3.6... Cisco Switch VNHQ-DMZ2-2960-1
4.3.7... Cisco Blade Switch VNHQ-BSA3020-0
4.3.8... Cisco Blade Switch VNHQ-BSA3020-1
4.3.9... Cisco Blade Switch VNHQ-BSA3020-2
4.3.10. Cisco Blade Switch VNHQ-BSA3020-3
4.3.11. Cisco Blade Switch VNHQ-BSA3020-4
4.3.12. Cisco Blade Switch VNHQ-BSA3020-5
4.3.13. Cisco VNHQ-UA3560-01F2
4.3.14. Cisco VNHQ-UA3560-01F3
4.3.15. Cisco VNHQ-UA3560-01F4
4.3.16. Cisco VNHQ-UA3560-01F8
4.3.17. Cisco VNHQ-UA3560-01M
4.3.18. Cisco VNHQ-UA2950-01Meeting
4.3.19. Cisco VNHQ-UA2960-CamAccDoor
4.3.20. Cisco VNHQ-UA3560-02F2 64
4.3.21. Cisco VNHQ-UA3560-02F3 65
4.3.22. Cisco VNHQ-UA3560-02F4 65
4.3.23. Cisco VNHQ-UA2960-02F8 65
4.3.24. Cisco VNHQ-UA2960-02M 65
4.3.25. Cisco Router VNEASY-IET2801R-1
4.3.26. Cisco Router VNHQ-IAT3845R-1
4.3.27. VNDRC-CD3750-1C
4.4 Device Port Connections.
4.4.1... Cisco Router VNPDC-IET2821R-1
4.4.2... Cisco Router VNHQ-IAT3845R-1
4.4.3... Cisco Switch VNHQ-CD4506-1A
4.4.4... Cisco Switch VNHQ-CD4506-2B
4.4.5... Cisco Switch VNHQ-DMZ1-2960-1
4.4.6... Cisco Switch VNHQ-DMZ2-2960-1
4.4.7... Cisco Blade Switch VNHQ-BSA3020-0 72
4.4.8... Cisco Blade Switch VNHQ-BSA3020-1 72
4.4.9... Cisco Blade Switch VNHQ-BSA3020-2 73
4.4.10. Cisco Blade Switch VNHQ-BSA3020-3 73
4.4.11. Cisco Blade Switch VNHQ-BSA3020-4 74
4.4.12. Cisco Blade Switch VNHQ-BSA3020-5 74
4.4.13. Cisco VNHQ-UA3560-01F2 74
4.4.14. Cisco VNHQ-UA3560-02F2 74
4.4.15. Cisco VNHQ-UA3560-01F3 75
4.4.16. Cisco VNHQ-UA3560-02F3 75
4.4.17. Cisco VNHQ-UA3560-01F4 75
4.4.18. Cisco VNHQ-UA3560-02F4 75
4.4.19. Cisco VNHQ-UA3560-01F8 75
4.4.20. Cisco VNHQ-UA2960-02F8 75
4.4.21. Cisco VNHQ-UA3560-01M 76
4.4.22. Cisco VNHQ-UA2960-02M 76
4.4.23. Cisco VNHQ-UA2950-01Meeting 76
4.4.24. Cisco VNHQ-UA2960-01CamAcc 76
4.4.25. Cisco Router VNEASY-IET2801R-1 76
4.4.26. Cisco Router VNEASY-IAT3845R-1 77
4.4.27. Cisco VNDRC-CD3750-1C 77
4.4.28. Cisco VNEASY-CD3750-2 78
4.4.29. Cisco VNEASY-ASA5505-1 78
4.4.30. Cisco Router VNHN-2821R-1 78
4.4.31. Cisco Router VNHN-IAT878R-1 79
4.4.32. Cisco VNHN-PIX506-1 79
Chapter 5. Network Device Configuration Parameters. 80
5.1 Common Configuration Settings. 80
5.1.1 Cisco IOS Switches 80
5.1.2 Cisco IOS Router 82
5.2 Individual Configuration Settings. 83
5.2.1... Cisco Catalyst VNHQ-CD45061-1A 83
5.2.2... Cisco Catalyst VNHQ-CD45061-2B 103
5.2.3... Cisco Catalyst VNDRC-CD3750-1C 125
Chapter 6. CheckPoint UTM-1 Firewall Device Configuration Parameters. 126
6.1 VPN/Firewall Topology Diagram.. 126
6.1.1 Overview Diagram 126
6.2 Checkpoint Firewall configuration. 130
6.2.1... Configuration parameters 130
6.2.2 NAT configuration 141
6.2.3... Routing configuration 143
Chapter 7. VPN Site-to-Site over Internet Configuration Parameters. 145
7.1 VPN/Firewall Topology Diagram.. 145
7.1.1 Overview Diagram: 145
7.1.2... Network Connections: 145
7.2 Configuration Parameters on VPN Cisco/CheckPoint Devices. 145
7.2.1... Cisco ASA Firewall configuration (VNEASY-ASA5505-1) 145
7.2.2... Cisco PIX Firewall configuration (VNHN-PIX506-1) 147
7.2.3... Checkpoint UTM-1 Firewall configuration 148
Chapter 8. Network Management. 149
8.1 Network Management System.. 149
8.1.1 NagVis: 149
8.1.2 Cacti: 149
8.2 IP Connectivity Table. 150
8.3 IP Address Parameters. 151


B. Infrastructure Desing Document
Table of Contents
Chapter 1. Management Summary. 4
1.1 How this document is organized. 4
1.2 Conventions. 4
Chapter 2. HC Viet Nam Data Center Infastructure Overview for Support. 5
2.1 Storage Area Network Overview.. 5
2.1.1 SAN Infastructure Overview. 5
2.1.2 Primary SAN network (PDC) 6
2.1.3 Disaster SAN network (DRC) 8
2.2 Data Center Room Overview.. 8
2.2.1 InfraStruXure Data Center Solution. 8
2.2.2 VESDA Xtralis Early Warning Safety and Security Solution. 10
Chapter 3. Logical Storage Area Network Architecture. 12
3.1 HP StorageWorks SAN Topology. 12
3.2 HP StorageWorks SAN Components at HC Viet Nam.. 14
3.2.1 SAN Switches. 14
3.2.2 Storage devices – HP EVA4400. 14
3.2.3 Blade System/Servers and HBAs. 15
3.2.4 Cabling and cable connectors. 15
3.2.5 SAN management applications. 15
3.3 IP Addressing Range. 16
3.4 DNS Name/Device Host Name. 16
3.4.1 SAN Switch Devices: 16
3.4.2 SAN Storage Server: 16
3.4.3 HP BladeSystem C7000 Enclosures. 16
3.4.4 Other HP Servers. 17
3.4.5 Virtual Servers on VMWare. 17
3.4.6 HP Tape Drivers. 19
3.5 HP StorageWorks Replication Solution. 19
3.6 SAN Diagram.. 20
Chapter 4. Physical Storage Area Network Architecture. 21
4.1 Cabling and Rack/Floor/Building Infrastructure. 21
4.2 Device Names and Locations. 22
4.3 Device Hardware Configuration. 22
4.3.1 HP BladeSystem C7000 BackOffice. 22
4.3.2 HP BladeSystem C7000 Homer 23
4.3.3 EVA4400 BackOffice ID1. 24
4.3.4 HP EVA4400 DRC ID3. 26
4.3.5 HP EVA 4400 HOMER ID2. 28
4.3.6 HP MSA P2000 G3. 28
4.3.7 HP StorageWork 4/32B Full SAN Switch - fscw22 (PDC) 29
4.3.8 HP StorageWork 4/32B Full SAN Switch - fscw23 (PDC) 29
4.3.9 HP StorageWork 4/32B Full SAN Switch - SW8 (DRC) 30
4.3.10 HP StorageWork 4/32B Full SAN Switch - SW9 (DRC) 30
4.3.11 HP Brocade 4Gb SAN Switch - SW20 (BlaceSystem C7000 BO) 31
4.3.12 HP Brocade 4Gb SAN Switch - SW21 (BlaceSystem C7000 BO) 31
4.4 Device Port Connections. 32
4.4.1 HP BladeSystem C7000 Enclosure BackOffice. 32
4.4.2 HP BladeSystem C7000 Enclosure HOMER. 35
4.4.3 EVA 4400 BackOffice ID1. 35
4.4.4 EVA 4400 DRC ID3. 36
4.4.5 EVA 4400 Homer ID2. 36
4.4.6 HP MSA P2000 G3. 36
4.4.7 HP SAN Switch fscw22 – PDC. 37
4.4.8 HP SAN Switch fscw23 – PDC. 37
4.4.9 HP SAN Switch sw8 – DRC. 37
4.4.10 HP SAN Switch sw9 – DRC. 37
Chapter 5. Storage Area Network Device Configuration Parameters. 38
5.1 SAN Switch Configuration Parameters. 38
5.1.1 HP StoreWorks 4/32B Full SAN Switch configuration (fscw23 – PDC) 38
5.1.2 HP StorageWorks 4/32B Full SAN Switch configuration (fscw22 – PDC) 42
5.1.3 HP StorageWorks 4/32B Full SAN Switch configuration – SW8 (DRC) 46
5.1.4 HP StorageWorks 4/32B Full SAN Switch configuration - SW9 (DRC) 46
5.1.5 HP Brocade 4G SAN Switch configuration - SW20 (BladeSystem C7000 BO) 47
5.1.6 HP Brocade 4G SAN Switch configuration - SW21 (BladeSystem C7000 BO) 48
5.1.7 HP 4GB VC-FC Switch 01 configuration on HOMER Blade Enclosure. 48
5.1.8 HP 4GB VC-FC Switch 02 configuration on HOMER Blade Enclosure. 48
5.2 HP Virtual Connect Ethernet on BackOffice Blade Enclosure. 48
5.2.1 Port Mapping – Interconnect Bay 1 (Cisco Catalyst Blade Switch 3020) 48
5.2.2 Port Mapping – Interconnect Bay 2 (Cisco Catalyst Blade Switch 3020) 49
5.2.3 Port Mapping – Interconnect Bay 5 (Cisco Catalyst Blade Switch 3020) 50
5.2.4 Port Mapping – Interconnect Bay 6 (Cisco Catalyst Blade Switch 3020) 50
5.2.5 Port Mapping – Interconnect Bay 7 (Cisco Catalyst Blade Switch 3020) 50
5.2.6 Port Mapping – Interconnect Bay 8 (Cisco Catalyst Blade Switch 3020) 51
5.3 HP Virtual Connect Ethernet on HOMER Blade Enclosure. 51
5.3.1 Port Mapping – Interconnect Bay 1 (HP 1/10GB VC-Enet Module) 51
5.3.2 Port Mapping – Interconnect Bay 2 (HP 1/10GB VC-Enet Module) 52
5.4 Storage Server Configuration Parameters. 52
5.4.1 EVA 4400 BackOffice ID1. 52
5.4.2 EVA 4400 DRC ID3. 65
5.4.3 EVA 4400 HOMER ID2. 75
5.4.4 MSA P2000 G3. 76
5.5 HP Servers. 78
5.5.1 VNHQESX01 on Enclosure BackOffice (Bay 1) 78
5.5.2 VNHQESX02 on Enclosure BackOffice (Bay 2) 79
5.5.3 VNHQMAS03 on Enclosure BackOffice (Bay 6) 80
5.5.4 VHPVM01 on Enclosure BackOffice (Bay 8) 80
5.5.5 VNHQPWS02 on Enclosure BackOffice (Bay 9) 81
5.5.6 VNHQPAP02 on Enclosure BackOffice (Bay 10) 82
5.5.7 VNHQESX03 on Enclosure BackOffice (Bay 11) 82
5.5.8 VNHQESX04 on Enclosure BackOffice (Bay 12) 83
5.5.9 VNHQMAS01 on Enclosure BackOffice (Bay 13) 84
5.5.10 VNHQESX05 on Enclosure BackOffice (Bay 14) 85
5.5.11 VNHQESX06 at DRC. 85
5.5.12 VNHQESX07 at DRC. 86
5.6 MSL4048 Tape Library. 87
Chapter 6. Storage Area Network Management. 90
6.1 Storage Area Management 90
6.2 ILO IP Address Table. 90
6.3 IP Address Parameters. 90
Chapter 7. Data Center Solution at HC Viet Nam.. 91
7.1 InfraStruXure Data Center Solution. 91
7.1.1 APC Rack System – NetShelter SX Enclosure. 91
7.1.2 Power System.. 94
7.1.3 NetBotz security and environmental monitoring. 107
7.1.4 Cooling System.. 114
7.1.5 Management and Service. 119
7.2 VESDA Xtralis Early Warning Safety and Security Solution. 120
7.2.1 VESDA System.. 120
7.2.2 FM200 Fire Protection System

C. Telecom Design Document
Table of content
Chapter 1. Management summary. 6
1.1 How this document is organized. 6
1.2 Conventions. 6
Chapter 2. Telecom System Overview.. 7
2.1 Telecom System Diagram.. 7
2.2 Aastra MX-ONE IP-PBX Overview. 8
2.3 Solidus eCare Overview. 11
2.4 RedBOX - Recording System.. 18
2.5 2N StarGate GSM Gateway. 20
2.6 SMS System.. 23
2.7 Incoming Call and Outgoing Call Routing. 24
Chapter 3. Logical Telecom System Network. 25
3.1 Topology. 25
3.2 IP Subnets. 25
3.3 IP Addressing. 25
3.4 Logical Overview Diagram.. 26
Chapter 4. Physical Telecom System Architecture. 27
4.1 Cabling and Rack/Floor/Building Infrastructure. 27
4.2 Device/Card Names and Locations. 28
4.3 Device/Card/Board Hardware Configuration. 28
4.3.1 Aastra MX-ONE PBX. 28
4.3.2 Ericsson BP250-Beta. 29
4.3.3 Ericsson BP250-HaNoi 29
4.3.4 MX-ONE Telephony server (TSE) 30
4.3.5 VNHQCCS01 server 30
4.3.6 VNHQIT66 server 30
4.3.7 VNHQRBR01 server 31
4.3.8 VNHQSQL01 server 31
4.4 Device/Card/Board Port Connections. 31
4.4.1 MX- ONE Media Gateway. 31
4.4.2 MX-ONE Telephony server (TSE) 32
4.4.3 VNHQCCS01 server 32
4.4.4 VNHQIT66 server 33
4.4.5 VNHQRBR01 server 33
4.4.6 VNHQSQL01 server 33
4.4.7 Ericsson BP250-Beta. 33
4.4.8 Ericsson BP250-HaNoi 33
Chapter 5. Site Information. 35
5.1 Site Address Information. 35
5.2 Site Characteristics. 36
5.3 Links to PSTN/PBX. 36
Chapter 6. Telephony Aastra MX-ONE IP-PBX Configuration Parameters. 40
6.1 Links to PSTN/PBX. 40
6.2 Numbering Plan, Dial Plan. 40
6.3 Phone and Customer 43
6.3.1 Phone Button Templates. 43
6.3.2 Common Service Profiles. 43
6.3.3 Extension Directory. 43
6.3.4 Directory Number Profile. 49
6.3.5 Key System Directory Data. 50
6.3.6 Key System Category Print 52
6.3.7 IP Extension Data. 54
6.3.8 Extension Category Fields. 59
6.3.9 Extension Directory Data. 59
6.3.10 Call List Information. 59
6.4 List Routes and Trunks. 60
6.4.1 List Routes. 60
6.4.2 List Trunks. 60
6.4.3 Number Conversion Data. 61
6.4.4 External Destination Route Data. 61
6.4.5 Route Category Data. 62
6.4.6 Route Day and Night Number Data. 63
6.5 Least Cost Routing – LCR. 63
6.6 Pickup Group. 63
6.7 Hunt Group. 64
6.8 ACD parameters. 64
6.9 Common Category. 65
6.10 Operator Group configuration. 65
6.11 MX-ONE PBX’s License information. 65
6.12 H323 Gateway. 67
6.13 GSM Gateway configuration. 67
6.13.1 System Parameters. 67
6.13.2 ISDN Parameters. 68
6.13.3 GSM Basic Parameters. 68
6.13.4 GSM Group Assignment 68
6.13.5 GSM Outgoing Groups. 70
6.13.6 GSM Incoming Groups. 71
6.13.7 Prefix List 71
6.13.8 Least Cost Routing Table. 72
Chapter 7. Solidus ECare Configuration Parameters. 73
7.1 Contact Center System Properties. 73
7.2 Skilled Users. 75
7.3 Service Access. 78
7.4 Service Groups. 82
7.5 Agent Groups. 91
7.6 Call Qualification Codes. 91
7.7 Play Messages. 92
7.8 Call Campaigns. 92
7.9 IVR – Interactive Voice Response. 93
Chapter 8. RedBox Configuration Parameters. 94
8.1 Network Settings. 94
8.2 Licensing the recorder 94
8.3 Configuring recording. 94
8.4 Configuring channel labels. 97
8.5 Groups. 97
8.6 Misc Settings. 98
8.7 Calls Store (Callstore) 98
8.8 Database Details. 98
Chapter 9. SMS System Configuration Parameters. 100
9.1 SMS Autosender Parameters. 100
9.2 SMS Template Files. 100
9.3 Monitor and Report 101
Chapter 10. Telecom System Management 102
10.1 Telecom System Management 102
10.2 IP Address/Connectivity Table. 102
10.3 Call Accounting System