Using the Documentation According to the Roles of Users

Users have different roles according to their responsibilities on a network. Users of different roles can obtain different documents according to their responsibilities.

**Table 1** Using the documentation according to the roles of users
User's Role	Job Responsibilities	Manuals to Be Used
User's Role	Job Responsibilities	Main Manuals	Reference Manuals
Network planning engineer	Planning, design, and optimization of the whole network, including the engineering design and the design of the scheme for the upgrading and expansion of the network	Product Description Feature Description Hardware Description	-
Hardware installation engineer	Install the hardware of the device according to the hardware planning and scheme of the project, including: Checking the installation environment Preparing the installation environment Preparing power modules Preparing installation Laying out cables The installation should meet the acceptance requirements.	Installation Guide Quick Installation Guide	Product Description Hardware Description Replacing Components
Commissioning engineer	Powering on the devices, debugging the single device and circuits, debugging and deploying and cutover of services, and delivering the network to the maintenance department after the acceptance is completed.	Configuration Guide Commissioning Guide	Installation Guide Quick Installation Guide Product Description Hardware Description Feature Description Troubleshooting Command Reference Alarm Reference Log Reference
Data configuration engineer	Configuring data and services to the device by using command lines or through network management interfaces	Configuration Guide	Command Reference Product Description Hardware Description Feature Description
On-site maintenance engineer	Operating and maintaining the device on site, including: Monitoring the environment Cleaning the dust Cleaning and replacing air filters Replacing components Assisting in upgrading versions Circuit cutover	Routine Maintenance Replacing Components	Hardware Description Product Description Installation Guide
Network monitoring engineer	Monitoring the network 24 hours a day according to a provider's strategy Maintaining the network routinely and disposing minor faults Handling users' claims Requesting system maintenance engineers to handle complicated faults when a critical fault occurs, take immediate actions to dispose the device under a system maintenance engineer's guidance or turn to a system maintenance engineer Monitoring the network by using the NMS or the command lines	Routine Maintenance Emergency Maintenance	Product Description Configuration Guide Troubleshooting Command Reference Alarm Reference Log Reference
System maintenance engineer	Responsible for maintaining the running devices, especially for the troubleshooting and network management system Coordinating and commanding the large scale upgrading of the version of software Reviewing the limited-scale upgrading of the version of software	Troubleshooting	Installation Guide Quick Installation Guide Product Description Feature Description Hardware Description Configuration Guide Command Reference Alarm Reference Log Reference Replacing Parts Routine Maintenance Emergency Maintenance Security Maintenance
Network administrator	Managing and maintaining the NMS	The package of documents for the NMS.

Documents are classified into main documents and reference documents.

A main document is mainly used by a user in a specific scenario.
A reference document, which supplements the main document, instructs users to complete the tasks in a specific scenario.

For example, to perform a configuration task, an operator may need to read the Configuration Guide to be familiar with the procedure for performing the configuration task. In addition, the operator needs to read the Command Reference to know about the usage and the value range of the parameters of the related commands. In this scenario, the Configuration Guide is a main document and the Command Reference is a reference document.