Help:Web portal tutorial guidelines

TelcoBridges support multiple versions simultaneously. We are therefore forced to maintain multiple procedures because of interface changes.This goes somewhat against the wiki philosophy where you always have the latest and the greatest.

The following naming convention takes into consideration:

• Support multiple versions of the same procedure
• Avoid duplication of the same content
• Relevant page title
• Quickly know which version a page applies

Web portal tutorial convention

The following are mandatory when describing web procedures.

Page title

• Toolpack version number are no longer in the title

Example

Toolpack:Creating_a_New_Gateway_Configuration_A

• Versions of the same page are identify with letters

First version of the procedure

Toolpack:Creating_a_New_Gateway_Configuration_A

Second version

Toolpack:Creating_a_New_Gateway_Configuration_B

Page content

• First sentence contains Toolpack version

Applies to version(s): v2.5, v2.6.

Wiki code for page that is the same for v2.5 and v2.6

=== '''''Applies to version(s): v2.5, v2.6.''''' ===

• Set display title (Note: that the version is not present)

Example for page 'Toolpack:Creating_an_IP_Port_Range_A'

{{DISPLAYTITLE:Creating an IP Port Range}}

Tips

• Establish the tasks sequence and those to the main web portal guide page (1 form per page)

Example:Configuring the ISUP Layer

• Title should starts with a verb that represent an action.

Example: Adding an Adapter, Edit the SCTP Configuration

• Each steps should contain a summary stating its objective.

Example: Toolpack:Creating_an_MTP3_Network

• Add screen shots to the procedure

• First screen shot shows the navigation panel
• Second screen shot shows the information panel and what the user should click.
• Third screen shot shows the fields to fill.
• Last screen shot shows a result message ("something" was create successfully)

Example: Toolpack:Creating_an_ISUP_Interface

Terminology

• Buttons are clicked
• Links are clicked or selected
• Items in a list is selected
• Check-boxes are selected or cleared
• Drop-box are referred as list (MTP3 example: Select a sub service field)