<< Click to Display Table of Contents >> Navigation: Library Information > Documentation Guide |
Navigation: Library Information >
This topic describes the composition and contents of the unified gateway documents and how to obtain the documents.
Figure 1 shows the composition of the unified gateway documents.
Figure 1 Composition of the unified gateway documents
Table 1 describes the contents of the unified gateway documents.
Table 1 Contents of the unified gateway documents
Type |
Document |
Content |
Intended Audience |
|
Technical Support Personnel |
Enterprise User |
|||
Release documents |
Release Notes |
Describes the general information about an unified gateway version, including its version mapping, compatibility, feature updates, and known issues. This document is used during unified gateway deployment or upgrade. |
√ |
- |
Version Mapping |
Provides the general information about an unified gateway version and its version mapping. This document is used during unified gateway deployment or upgrade. |
√ |
- |
|
License Application Instructions |
Describes how to apply for a license for an unified gateway from official website. This document is used during unified gateway deployment or upgrade. |
√ |
- |
|
Acceptance Test Guide |
Describes how to accept all service functions after the unified gateway system installation and commissioning. This document is used during unified gateway deployment or upgrade. |
√ |
- |
|
General information |
Product Description |
Describes the highlights, positioning, architecture, features, operation and maintenance methods, and network applications of an unified gateway. |
√ |
√ |
Plan and design |
Plan and Design |
Describes the planning and preparations before the unified gateway installation and configuration. This document is used before unified gateway deployment. |
√ |
- |
Installation |
Quick Start |
Describes how to install an unified gateway on the shelf, connect cables, and power on the unified gateway. This document is used during unified gateway deployment. |
√ |
- |
Configuration |
Configuration Guide |
Describes how to configure an unified gateway and also how to configure its typical networks according to the configuration examples for typical scenarios. |
√ |
- |
Configuration Examples |
Describes the configuration processes for actual office deployments. |
√ |
- |
|
Operation and maintenance |
Administrator Guide |
Describes how the enterprise administrator performs routine operations and maintenance on an unified gateway. |
√ |
√ |
Voice Service Guide |
Describes how to configure and use the voice services. |
√ |
√ |
|
Security Management |
Describes the purpose and methods of security maintenance for an unified gateway. |
√ |
√ |
|
User Guide |
Describes how enterprise users activate and use voice services provided by an unified gateway. |
√ |
√ |
|
Troubleshooting |
Alarm Handling |
Describes how to handle alarms generated on an unified gateway. NOTE: When an alarm is generated, you can learn about the alarm handling methods according to the help information provided by related tools. |
√ |
√ |
Emergency Maintenance |
Describes how to restore voice services using related tools or simple commands when a large number of users cannot normally use the voice services due to an emergency fault. |
√ |
√ |
|
Troubleshooting Basics |
Describes how to troubleshoot simple faults and how to collect fault information. |
√ |
√ |
|
Troubleshooting Cases |
Describes how to troubleshoot complex faults from aspects of fault location and rectification. |
√ |
- |
|
Reference |
CDR Reference |
Describes CDR-related information, including its generation principle, format, operation, and troubleshooting. |
√ |
- |
Parameter Reference |
Describes unified gateway parameters and their functions. |
√ |
- |
|
Log Reference |
Describes the classification and format of the logs and how to obtain the logs for fault location. |
√ |
- |
|
Command Reference |
Describes command-related information including the command functions, syntax, parameters, and usage precautions. |
√ |
- |
|
Communication Matrix |
Describes the ports (including the port usage), protocols, IP addresses, and authentication modes used for network communication of the unified gateway. |
√ |
√ |
|
Glossary |
Glossary |
Describes the glossary used in the unified gateway documents. |
√ |
√ |
Parent Topic: Library Information