1. MMSC&MessagePlus Documentation Optimization Outcome in 2009
Consumer documentation team/RCS documentation team

2. Contents Overview of the MMSC/MessagePlus Documentation Optimization
Improvements in MMSC Documentation
Improvements in MessagePlus Documentation
Feedback
Page 2/63

3. Overview of the MMSC/MessagePlus Documentation Optimization
In 2009, the MMSC/MessagePlus documentation was optimized to support the entire process of E2E delivery. The important support documents such as the installation guide, commissioning guide, maintenance documentation, and topical documentation were optimized to improve the product value in terms of the product serviceability.
Page 3/63

4. Overview of the MMSC/MessagePlus Documentation Optimization
Preparations
Project implementation
Routine maintenance
Requirement research
Design and preinstallation
Installation
Commissioning
Acceptance, cutover
Data configuration
Upgrade
Troubleshooting
Routine maintenance
MMSC/MessagePlus on-site installation
planning/guide
MMSC/MessagePlus preinstallation
planning/guide
Network commissioning tool
Minimum documents
Topical documentation–data setting specifications
MMS zero distance
Video–MessagePlus interface commissioning
Topical documentation–DST setting
MMS by-one-click installation
Topical documentation–network commissioning guide
Installation documentation The documentation team cooperates with the product R&D team to optimize the automatic installation tool and its documentation during improvement of automatic installation, thus significantly raising the quality and efficiency of automatic MMS installation.
Network commissioning tool To improve the commissioning efficiency and configuration standardization, the IP address planning and network device configuration script are generated automatically according to the network planning of the network commissioning tool provided for some mainstream network devices.
Minimum delivery The complete set of MessagePlus documentation is optimized according to the minimum system construction rule. The documentation is reduced by 50%.
Maintenance documentation
The documentation team and maintenance&optimization team optimize the maintenance documentation completely by using the improvement outcome of the A&S maintenance documentation. More knowledge is described in the documentation, and the documentation practicability is improved.
Topical documentation This type of documentation includes data setting specifications, DST setting, and MMS zero distance, facilitating audience to learn and use the topical knowledge.
Video documentation To facilitate the field engineers to install and commission the O&M system matching the MessagePlus solution, the video of the O&M system installation is recorded. In addition, the video of the interface commissioning process is recorded in the uncoupling version of the MessagePlus.
Page 4/63

5. Contents Overview of the MMSC/MessagePlus Documentation Optimization
Improvements in MMSC Documentation
Improvements in MessagePlus Documentation
Feedback
Page 5/63

6. Overview of the MMSC/MessagePlus Documentation Optimization
The MMSC documentation was optimized in the following aspects in 2009:
The automatic installation tool and its documentation were optimized during improvement of automatic installation, thus significantly raising the quality and efficiency of automatic installation.
During preinstallation in Bahrain, a new customer service employee completed the MMSC installation within half a day by referring to the optimized preinstallation documents, which effectively ensures achievement of the 100-day ITO of the MMS service.
The MMS by-one-click installation document HUAWEI MMS-Component By-One-Click Installation Guide (V100R002C01L00620_01) was approved by the R&D department and supply chain department, tested by the test department, and released with the version.
The documentation team cooperated with the maintenance&optimization team on the "MMS zero distance" and arranged and classified the maintenance cases and on-site summary provided by the MMS maintenance&optimization team, R&D team, and 800 hotline. In addition, the development process is described in details, which became an important supplement to the after-sales maintenance document. The field engineers praise the documentation team for the helpful documents with detailed content.
The network data table for preparation was made in the MMSC network commissioning guide to complete the product commissioning documents.
To improve the network commissioning efficiency, the documentation team also developed the automatic MMSC network commissioning tool. For the development of this tool, the documentation team was awarded the first price for the best practice in the A&S documentation department in the Q3. Currently, more than 6 product groups are using this tool. During the report of the Consumer product line, this tool was praised and recognized by Mr. Liao and other product leaders in the teams of its creativity, practicability, and large application scope.
Page 6/63

7. Installation Documentation–Improvement 1
The installation guide is written according to the production pre-installation scenario.
Before
After
Page 7/63

8. Installation Documentation–Improvement 2
The method of changing the IP address in pre-installation of a project is provided.
Page 8/63

9. Installation Documentation–Improvement 3
The solutions of maintenance&optimization team to common errors and problems that occur during installation are collected and described in details in the documents. With the help of these documents, on-site operators may not perform incorrect operations repeatedly, thus reducing the workload of maintenance&optimization team.
Before
After
The relevant
introduction is lacking.
Page 9/63

10. Installation Documentation–How to Obtain
The installation guides are released with all the versions. You can view the installation guides in the version release path at
For example, you can find HUAWEI MMSC Installation Guide (V100R002C21L00003_01,SuSE10+Oracle11g) after choosing Software center > Version software > A&S > Data service > MMSC(518) > MMSC > MMSC V100R002 > MMSC V100R002C21L00003.
Page 10/63

11. Commissioning Documentation–Improvement 1
Before
After
Information that users want to know is provided.
The office data configuration is provided to make the initialization information of the current office clear.
The title reflects the application scenario to facilitate users to use.
The similar or mutually exclusive interfaces are described in the same chapter or section to prevent the audience from turning to one section or another too often.
The description of omitted interfaces is supplemented.
Page 11/63

12. Commissioning Documentation–Improvement 2
The interfaces are described in details, which helps audience to learn about the interfaces.
Before
After
Page 12/63

13. Commissioning Documentation–Improvement 3
The Excel file describing deployment data preparation is provided.
The content is not translated to the English version because the field engineers are generally Chinese. The English version will be provided if necessary.
Page 13/63

14. Commissioning Documentation–How to Obtain
The commissioning guides are released with all the versions, and only Huawei engineers can view the guides in the version release path at
For example, you can find HUAWEI MMSC Commissioning Guide after choosing Software center > Version software > A&S > Data service > MMSC(518) > MMSC > MMSC V100R002 > MMSC V100R002C21L00003.
Page 14/63

15. Maintenance Documentation–Improvement 1
The outline is redesigned based on the new template and the optimization outcome of the A&S
maintenance documentation. The new outline covers more knowledge.
Before
After
Page 15/63

16. Maintenance Documentation–Improvement 2
The faults are classified according to the symptom that users detect, which facilitates users
to find the troubleshooting entry from the title.
Before
After
Page 16/63

17. Maintenance Documentation–Improvement 3
Each type of emergency faults is described in terms of typical scenario, locating, troubleshooting,
verification, and typical cases.
Before
After
Page 17/63

18. Maintenance Documentation–Improvement 5
The remote maintenance items and on-site maintenance items are described separately,
which facilitates maintenance engineers to operate.
Before
Before the improvement, the remote maintenance items and on-site maintenance items are not distinguished.
After
Page 18/63

19. Maintenance Documentation–Improvement 6
The practicability of the content in operation guide and troubleshooting guide is improved.
Before
After
Page 19/63

20. Maintenance Documentation–How to Obtain
The maintenance documents are released with all the versions. You can view the maintenance documents in the version release path at
For example, after choosing Software center > Version software > A&S > Data service > MMSC(518) > MMSC > MMSC V100R002 > MMSC V100R002C21L00003, you can find the following documents:
HUAWEI MMSC Troubleshooting (V100R002C21L00003_01)
HUAWEI MMSC Routine Maintenance (V100R002C21L00003_01)
HUAWEI MMSC Emergency Maintenance (V100R002C21L00003_01)
Page 20/63

21. Topical Documentation–Maintenance Periodical
As a supplement to the after-sales maintenance documents, the "MMS zero distance" maintenance periodical
is made. In the periodical, more than 200 papers related to the common configurations, log information,
common knowledge, skills, tool set, and FAQ are collected. This periodical is already uploaded to the following
path at Software center > A&S > Data service > MMSC > Technical guide.
Currently, this periodical is in trail use in China and is being developed in the third phase. In this phase, the English version will be provided.
Page 21/63

22. Topical documentation–DST Setting
This documentation describes the method of setting the DST in the MMS system and also describes the impact of the DST on services and the avoidance measures in details.
This documentation is not uploaded to Contact MMSC documentation team members to obtain the documentation.
Page 22/63

23. Network Commissioning Tool
Providing one-stop network commissioning guide By using this tool, engineers can complete the commissioning of network devices without referring to other documents. This tool replaces the lengthy network commissioning guides.
Automatically planning IP addresses and firewall policies and automatically generating configuration scripts After engineers enter the basic project information, VLAN information, number of devices/applications, and information about public network/interconnected devices, this tool automatically generates the logical/physical networking diagram, plans IP addresses, plans firewall policies, and generates the configuration scripts of the switch/firewall/ATAE switch blade. In addition, this tool saves the configuration scripts in the current path as .txt files.
Supporting manual adjustment of IP addresses, replanning firewall policies, and regenerating configuration scripts
This tool is not uploaded to Contact MMSC documentation team members to obtain the tool.
Page 23/63

24. Contents Overview of the MMSC/MessagePlus Documentation Optimization
Improvements in MMSC Documentation
Improvements in MessagePlus Documentation
Feedback
Page 24/63

25. Overview of the MessagePlus Documentation Optimization
In 2009, the MessagePlus documentation was optimized multiple times according to the minimum system construction rule. After the optimization, the documentation was reduced by 50%. The installation documentation, commissioning documentation, and topical documentation were optimized to improve the documentation value.
Page 25/63

26. MessagePlus Documentation Optimization–Background
Initial:
37 documents (18 PISA documents + 15 MVAS documents + 4 solution documents)
Before optimization:
17 CMCC documents (with simply-assembled content and independent description of each component) Besides the CMCC documents, there are CT and OVS documents.
Separate user scenarios
- The same role and same scenario are involved in different modules.
Lack of uniform design
The component documents, solution documents, and platform documents are written illogically.
The content description is duplicated and redundant.
The document structures and expressions are different.
Some information is described in details, whereas other is described simply.
Illogically combination
Seperate Scenario
Inconsistency
Hard to search for M+
Hard to search for
Due to no uniform planning, a large number of documents exist; therefore, users are difficult to search for required information. For example, a user may refer to multiple documents when commissioning a service.
Different product implementation from the document description
-The requirements on the product are instable, the documents are not verified completely, and the product implementation is often different from the description in the document.
Page 26/63

27. MessagePlus Documentation Optimization–Solution Overview
The original description and solution of each of the two components are
combined into the solution overview. In addition, make full use of the DITA
technology to provide documents for multiple offices and multiple types of
audience.
Before combination: 147 pages; after combination: 71 pages. The number of pages are reduced by 76.
Delete redundant information and ensure content
consistency
Combine duplicated content
Provide documents that meet the requirements of both
users and customer service employees
Distinguish users
Provide documents for different offices through DITA
Reuse design thoughts
Highlight the product value by referring to the existing design
thoughts
Highlight product values

28. MessagePlus Documentation Optimization–Online Help
The traditional design thoughts are changed, and the one
question and one answer mode is adopted.
1. Services change after being configured
2. The one question and one answer mode helps
users learn about products.
Close to users
Each service has only one page.
Simplification
The customized help is provided based on the reuse
Technology of DITA.
Reuse design

29. Commissioning Guide–Improvement 1
[Describing service process for the first time ]
The service process is added, and the internal modules in the system are described.
Page 29/63

30. Commissioning Guide–Improvement 2
[Providing office data summary for the first time.]
1. Office data contains the data provided by the carrier and data provided by external NEs.
2. Each piece of office data contains not only the office data itself but also its source and configuration.
Page 30/63

31. Commissioning Guide–Improvement 3
[E2E commissioning procedure ]
The procedures for commissioning the system on local and remote servers are described in details.
Field engineers can complete system commissioning without referring to multiple documents, thus
improving the commissioning efficiency.
Page 31/63

32. Commissioning Guide–Improvement 4
[Clear commissioning thoughts]
The server and client are distinguished, and the commissioning procedure and
objective are described.
Before
After
Page 32/63

33. Commissioning Guide–Improvement 5
[Service commissioning based on scenarios]
The function commissioning content is added to the service commissioning content;
therefore, field engineers do not need to refer to multiple modules.
Before
After
Page 33/63

34. Installation Guide–Improvement 1
[More measures ensure installation correctness.]
1. The verification method is provided after each installation task is complete.
2. Multiple solutions are provided and automatic rollback is supported if an exception occurs.
Common exceptions
Detailed solution
During rollback, only the applications need to be rolled back instead of rollback from the operating system. e
Page 34/63

35. Installation Guide–Improvement 2
[Much higher Automation degree]
The degree of automatic installation is much higher.
Before
After
Page 35/63

36. MessagePlus Documentation Optimization–How to Obtain
The MessagePlus documents are released with the B283 and C11 versions. You can view the installation guides in the version release path at
Path for obtaining the MessagePlus document of the B283 version:
Path for obtaining the MessagePlus document of the M+C11 version:
Page 36/63

37. MessagePlus Documentation Optimization–Outcome
Comparison Item
Before
After
Document length
The document has 4200 pages.
The document has 1970 pages.The document length is reduced by about 50%.
Maintainability
The document is difficult to maintain. Documents of multiple carriers are provided. For the installation guide provided for different carriers (for example, 3) and different deployment schemes (for example, 6), multiple sets of documents are required.
The simplified documents are customized through the DITA technology for different carriers to improve the development efficiency.
Consistency
Each component is designed and developed independently; therefore, the contents and styles of different documents are inconsistent.
The documents are designed in a uniform style. The outline and configuration planning of each document are provided. In addition, the writing style and granularity are specified, and the detailed writing examples are provided.
Easy to search
A user needs to search multiple documents to perform a task.
The scenario is used as the search entry, and all the documents are uniformly planned. A user can easily obtain the required information without referring to multiple documents.
Correctness
The documents are not verified and tested completely. The on-site engineers often complain about the incorrectness and poor practicability of the documents.
The documents are verified by the writers, customer service employees, and test engineers, which ensures the correctness of the documents.
Page 37/63

38. MessagePlus Topical Documentation–DST Setting
This topical documentation describes the method of setting the DST in the MMS system and also describes the impact of the DST on the service and the avoidance measures in details.
This documentation is not uploaded to Contact MessagePlus documentation team members to obtain the documentation.
Page 38/63

39. MessagePlus Topical Documentation–Data Structure
The description of the MessagePlus data structure is added. The features and structures of five types of tables in the MessagePlus system are described in details.
Due to the high confidentiality of data structure, the P2P delivery mode is adopted, and the documentation is not released to the http//support/huawei.com website. The field engineers can contact the technical service agents to obtain the documentation .
Page 39/63

40. MessagePlus Network Commissioning Tool
Providing one-stop network commissioning guide By using this tool, engineers can complete the commissioning of network devices without referring to other documents. This tool replaces the lengthy network commissioning guides.
Automatically planning IP addresses and firewall policies and automatically generating configuration scripts After engineers enter the basic project information, VLAN information, number of devices/applications, and information about public network/interconnected devices, this tool automatically generates the logical/physical networking diagram, plans IP addresses, plans firewall policies, and generates the configuration scripts of the switch/firewall/ATAE switch blade. In addition, this tool saves the configuration scripts in the current path as .txt files.
Supporting manual adjustment of IP addresses, replanning the firewall policies, and regenerating configuration scripts
This tool is not uploaded to Contact MessagePlus documentation team members to obtain the tool.
Page 40/63

41. MessagePlus Multimedia Documentation
The technical support employee, Wen Jun, recorded the system installation
video for the O&M system that matches the MessagePlus solution.
To obtain the video, access
The video of the interface commissioning process is recorded in the
MessagePlus uncoupling version, which helps field engineers to
commission the system.
This multimedia document is provided for field engineers during version deployment.
Page 41/63

42. Contents Overview of the MMSC/MessagePlus Documentation Optimization
Improvements in MMSC Documentation
Improvements in MessagePlus Documentation
Feedback
Page 42/63

43. Feedback
Your comments or suggestions on the documentation delivery mode, availability, and correctness are always welcome. If you have any requirements, do not hesitate to contact us. Your feedback is the basis of the improvement.
Contact: Xu Yaqin
Page 43/63

44. Thank You