Documente Academic
Documente Profesional
Documente Cultură
V100R019C02
Documentation Guide
Issue
01
Date
2011-07-30
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and the
customer. All or part of the products, services and features described in this document may not be within the
purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information,
and recommendations in this document are provided "AS IS" without warranties, guarantees or representations
of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute the warranty of any kind, express or implied.
Website:
http://www.huawei.com
Email:
support@huawei.com
Issue 01 (2011-07-30)
Documentation retrieval
Documentation architecture
Related documents
Documentation development
Documentation release
Configuration engineers
Symbol Conventions
The following symbols may be found in this document. They are defined as follows
Symbol
Description
Indicates a hazard with a high level of risk which, if not
avoided, will result in death or serious injury. Indicates a
hazard with a medium or low level of risk.
Indicates a hazard with a medium or low level of risk
which, if not avoided, could result in minor or moderate
injury.
Indicates a potentially hazardous situation that, if not
avoided, could cause equipment damage, data loss, and
performance degradation, or unexpected results.
Issue 01 (2011-07-30)
ii
Symbol
Description
Indicates a tip that may help you solve a problem or save
your time.
Provides additional information to emphasize or
supplement important points of the main text.
Update History
Updates between document issues are cumulative. Therefore, the latest document issue contains
all updates made in previous issues.
Issue 01 (2011-07-30)
iii
Contents
Contents
About This Document.....................................................................................................................ii
1 Version Mapping...........................................................................................................................1
2 How to use Documentation.........................................................................................................2
3 Documentation Details.................................................................................................................4
3.1 Product Documentation......................................................................................................................................5
3.2 Online Help.........................................................................................................................................................8
3.3 Release Documentation......................................................................................................................................9
4 Documentation Conventions....................................................................................................10
5 Standards-Compliant Documentation Development..........................................................12
6 Documentation Access and Feedback.....................................................................................13
6.1 Where to Obtain Documentation......................................................................................................................14
6.2 How to Provide Documentation Feedback.......................................................................................................14
7 Technical Support.......................................................................................................................16
Issue 01 (2011-07-30)
iv
1 Version Mapping
Version Mapping
Table 1-1 Version mapping between the UA5000 and the U2000
Product Name
Product Version
UA5000
V100R019C02
U2000
Issue 01 (2011-07-30)
It is recommended that equipment operators search for the required document according to the
current network operation phase of the equipment. According to different network operation
phases and user roles, Figure 2-1 shows the recommended method of retrieving documents.
Figure 2-1 Role- and scenario-based documentation
Network
phase
Service
provision
Network
maintenance
Network
upgrade
Field
Maintenance
Administrator
Guide
Release
Notes
Product
Description
Hardware
Description
Commissioning
Guide
Command
Reference
Operation
Guide
Alarm
Reference
All other
documents
Parts
Replacement
Product
Description
Upgrade
Instructions
Feature
Description
Configuration
Guide
Product
Description
Product
Description
Performance
Metrics
Reference
Hardware
Description
Feature
Description
Hardware
Description
Command
Reference
Feature
Description
Product
Description
Hardware
Description
Trouble
shooting
Product
Description
System
maintenance
engineer
Troublesho
oting
System
administrator
Routine
Maintenanc
e
Field
maintenance
engineer
Northbound
Interface
User Guide
System
maintenance
engineer
Configuration
Guide
Network
monitoring
engineer
Software
Installation
Guide
Application
development
engineer
Hardware
Installation
Guide
Hardware
installation
engineer
Planning
Guidelines
Network
planning
engineer
Data
configuration
engineer
Network
deployment
Secondary
document
Installation
commissioning
engineer
Network
planning
Primary
document
Audience
Troubleshoo
ting
Product
Description
Performance
Metrics
Reference
Table 2-1 lists the tasks and recommended documents related to network maintenance.
Issue 01 (2011-07-30)
Recommended Document
Network monitoring
Alarm Reference
Routine Maintenance
Issue 01 (2011-07-30)
Preventive maintenance
Routine Maintenance
Troubleshooting
Routine Maintenance
Emergency maintenance
Routine Maintenance
3 Documentation Details
Documentation Details
Issue 01 (2011-07-30)
3 Documentation Details
Issue 01 (2011-07-30)
Document
Description
Documentation
Guide
Library Overview
Product
Description
Hardware
Description
Feature
Description
Environment
Monitoring
Installation
Guide
Installation
../node/Installation.pdf
Issue 01 (2011-07-30)
3 Documentation Details
Document
Description
Commissioning
and
Configuration
Guide
Commissioning
Configuration
Routine
Maintenance
Handling Alarms
and Events
Troubleshooting
Parts
Replacement
Compliance and
Safety Manual
Command
Reference
Commands
3 Documentation Details
Document
Description
Glossary
Glossary
Table 3-2 U2000 after-sales customer documentation associated with the UA5000
Document
Description
Issue 01 (2011-07-30)
3 Documentation Details
Document
Description
Based on the product utilization and users' operation habits, the focuses of the product
documentation and Online Help are different. Online Help describes operation and
maintenance tasks based on the GUI, while the product documentation describes operation
and maintenance scenarios based on the product utilization.
Both the product documentation and Online Help describe major tasks pertaining to
operation and maintenance tasks.
Issue 01 (2011-07-30)
3 Documentation Details
Issue 01 (2011-07-30)
Document
Description
Release Notes
Upgrade Guide
4 Documentation Conventions
Documentation Conventions
This topic describes the conventions for the after-sales customer documentation of the
UA5000. The symbols that may be found in this document are defined as follows:
Symbol Conventions
Symbol
Description
Indicates a hazard with a high level of risk, which if
not avoided, will result in death or serious injury.
Indicates a hazard with a medium or low level of
risk, which if not avoided, could result in minor or
moderate injury.
Indicates a potentially hazardous situation, which if
not avoided, could result in device damage, data
loss, performance deterioration, or unexpected
results.
Indicates a tip that may help you solve a problem or
save time.
Provides additional information to emphasize or
supplement important points of the main text.
Command Conventions
Issue 01 (2011-07-30)
Convention
Description
Boldface
Italic
[]
10
4 Documentation Conventions
Convention
Description
{ x | y | ... }
[ x | y | ... ]
{ x | y | ... } *
[ x | y | ... ] *
GUI Conventions
Issue 01 (2011-07-30)
Convention
Description
Boldface
>
11
Standards-Compliant Documentation
Development
Development Process
The product documents are developed by the documentation department of Huawei. The
development of product documents includes the following phases:
1.
2.
3.
4.
5.
Releasing documents
By implementing each development stage and conducting reviews at the end of each stage,
documentation is of consistently high quality.
Standard Compliance
The documentation development process complies with the TL9000 standard of Quality
Excellence for Suppliers of Telecommunications (QuEST) Forum.
Issue 01 (2011-07-30)
12
Issue 01 (2011-07-30)
13
Phase
First installation
CD-ROM
Single Electronic
Document
NOTE
l Obtain the product documentation from http://support.huawei.com as follows: Homepage > Documentation
> Access Network ...
l It is recommended that you use your work email to register as an equipment customer for login to Huawei
support website. For any help, contact Huawei technical support engineers.
Online Help
The Online Help is integrated and released with software. You can access the Online Help by:
l
Release Documents
Release documents are released with the software package. You can apply to Huawei technical
support engineers for the documents.
14
Issue 01 (2011-07-30)
15
7 Technical Support
Technical Support
During the equipment operation and maintenance, if a fault occurs and is difficult to locate or
rectify, or if you cannot rectify the fault by referring to the after-sales customer documentation,
contact Huawei for assistance (Huawei engineers will provide guidance remotely or on site on
troubleshooting).
Call local Huawei branches or representative offices or contact Huawei Customer Service
Center.
1.
Call local Huawei branches or representative offices or contact Huawei Customer Service
Center.
2.
Issue 01 (2011-07-30)
16