ARMAAS PROCESS DOCUMENTATION

USER MANUAL

Document type : DRAFT

Reference : ARMaaS-User-Manual.doc

Purpose of the document

The purpose of this manual is to guide users through

the effective utilization of ARMaaS (Alliance
Relationship Management as a Service) for
streamlined management of cloud partner portals and
associated processes. It provides step-by-step
instructions, best practices, and troubleshooting tips
to empower users in maximizing the benefits of
ARMaaS, fostering strong partner relationships, and
achieving successful cloud collaborations.

This document is the property of the TDIT Group.

It may not be reproduced or communicated without the author's prior agreement.

ARMaaS-User-Manual.doc
Last modification May 27,2024
Author Satwick Dwivedi Version : 1.0 Page 1/9
Document history

Version Date Drafter Description

1.0 version 1

MU_UserManualTemplate.doc [<Application / Project XXX>]

Last modification 13 septembre 2011 à 13:57:00
Author DIT Version : 1.0 Page 2/9
 Contents

PURPOSE OF THE DOCUMENT 1

DOCUMENT HISTORY 2
1. ICONS USED IN THE MANUEL 4
2. PRESENTATION OF THE SOLUTION 4
2.1 Brief description 4
2.2 Descriptives Icons 4
2.3 Project players 4
2.4 Support 5
2.5 Referenced Documentation 5
2.6 History of the Solution 5
3. CONNECTING TO THE APPLICATION 6
3.1 Address 6
3.2 Authentication 6
4. STRUCTURING OF THE APPLICATION 6
4.1 Layout 6
4.2 Menus 7
4.3 Icons / Shortcuts 7
4.4 Functionalities 7
4.4.1 Functionalities Presented/Described 7
4.4.2 Functionalities not Presented/not Described 7
5. FUNCTION XXX / SCREEN XXX 7
5.1 Screenshot 7
5.2 Descriptions of fields, content 8
5.3 Description of actions 8
5.4 Sequence of screens 8
6. FUNCTION XXX / SCREEN XXX 8
6.1 Screenshot 8
6.2 Descriptions of fields, content 8
6.3 Description of actions 8
6.4 Sequence of screens 9
7. APPENDICES 9
7.1 Appendix 1 9
7.2 Appendix 2 9

1. ICONS USED IN THE MANUEL

Throughout this manual, the pictograms below are used to underline points or important notions

MU_UserManualTemplate.doc [<Application / Project XXX>]

Last modification 13 septembre 2011 à 13:57:00
Author DIT Version : 1.0 Page 3/9
 Important information

Good to know - Tricks

Risk in front of a parameter setting or of a specific action

Action to be avoided

Mandatory action

Sensitive or difficult procedure. To take into account necessarily

Actions reserved for the …. < Adapt the vocabulary according to the
application (administrator, manager, etc. >

Actions reserved for the … < Adapt the vocabulary according to the
application (user, publisher, etc. >

2. PRESENTATION OF THE SOLUTION

MU_UserManualTemplate.doc [<Application / Project XXX>]

Last modification 13 septembre 2011 à 13:57:00
Author DIT Version : 1.0 Page 4/9
1.1 BRIEF DESCRIPTION

<Give an outline description here>

1.2 DESCRIPTIVES ICONS

<Add if necessary, a table listing the specific signaling system to the application (icons,
buttons and associated actions).
Delete section so useless. >

1.3 PROJECT PLAYERS

<List all the players impacted by the project/solution here:

● Owner of the application

● Owner of the data

…
>

1.4 SUPPORT

<List what is needed for a support request here:

● Telephone

● E-mail

● Dedicated application

● …

Describe how to track the progress of the request in order to avoid excessive telephoning>

1.5 REFERENCED DOCUMENTATION

<Some documentation may be useful to the user in helping them understand how application-
related modules work.
List them here if applicable.
>

1.6 HISTORY OF THE SOLUTION

<Give the background here to the various stages in developing the solution from a user
viewpoint.>

MU_UserManualTemplate.doc [<Application / Project XXX>]

Last modification 13 septembre 2011 à 13:57:00
Author DIT Version : 1.0 Page 5/9
3. CONNECTING TO THE APPLICATION

1.7 ADDRESS

You must connect to the application using the following address:

<Insert the application's URL here>

1.8 AUTHENTICATION

<Indicate here what information must be given by the user to log on: login AD, surname first
name, e-mail address etc
Insert a screenshot of the authentication page.

Explain and show a screenshot of the page refusing unauthorised access. >

4. STRUCTURING OF THE APPLICATION

1.9 LAYOUT

<For a web application describe the structuring of the pages if they follow the same pattern.
An example is given below.>

Icons / Shorcuts

Processing area

1.10 MENUS

<List the menus, shown in tree-structure >

MU_UserManualTemplate.doc [<Application / Project XXX>]

Last modification 13 septembre 2011 à 13:57:00
Author DIT Version : 1.0 Page 6/9
1.11 ICONS / SHORTCUTS

<Show each icon or shortcut, together with a description. >

1.12 FUNCTIONALITIES

1.12.1 FUNCTIONALITIES PRESENTED/DESCRIBED

<List here all the functionalities that will be described in the document.
You could group together a number of similar functions or functionalities linked within a
workflow for example. These groupings should be shown here to give the user the map they
need to read the document. >

1.12.2 FUNCTIONALITIES NOT PRESENTED/NOT DESCRIBED

<List here all the functionalities that will not be described in the document.

It is not necessary to present all the functionalities of an application:

● because it is already described elsewhere: you could insert a link or reference etc

● because the functionality is unimportant

● …

>

5. FUNCTION XXX / SCREEN XXX

<Description of the functionality >

1.13 SCREENSHOT

<Not absolutely necessary but often very useful, with arrowed explanations, and boxing or
circling of different fields for user input or presentation>

1.14 DESCRIPTIONS OF FIELDS, CONTENT

<Show the fields, particularly the mandatory fields, and/or the input masks which are
checked
Show the colour codes if there are any.
Show the lists and explain their content
…>

MU_UserManualTemplate.doc [<Application / Project XXX>]

Last modification 13 septembre 2011 à 13:57:00
Author DIT Version : 1.0 Page 7/9
1.15 DESCRIPTION OF ACTIONS

<Explain the actions possible for the given screen, and the consequences, without
reproducing the functional specifications.
Nevertheless it may prove useful, if not necessary, to reiterate a business rule or
management rule.>

1.16 SEQUENCE OF SCREENS

<If necessary show the sequence of screens.>

6. FUNCTION XXX / SCREEN XXX

<Description of the functionality >

1.17 SCREENSHOT

<Not absolutely necessary but often very useful, with arrowed explanations, and boxing or
circling of different fields for user input or presentation>

1.18 DESCRIPTIONS OF FIELDS, CONTENT

<Show the fields, particularly the mandatory fields, and/or the input masks which are
checked
Show the colour codes if there are any.
Show the lists and explain their content
…>

1.19 DESCRIPTION OF ACTIONS

<Explain the actions possible for the given screen, and the consequences, without
reproducing the functional specifications.
Nevertheless it may prove useful, if not necessary, to reiterate a business rule or
management rule.>

1.20 SEQUENCE OF SCREENS

<If necessary show the sequence of screens.>

7. APPENDICES

MU_UserManualTemplate.doc [<Application / Project XXX>]

Last modification 13 septembre 2011 à 13:57:00
Author DIT Version : 1.0 Page 8/9
1.21 APPENDIX 1

<Give here any additional information that could make the functional specifications easier to
understand.>

1.22 APPENDIX 2

End of document

MU_UserManualTemplate.doc [<Application / Project XXX>]

Last modification 13 septembre 2011 à 13:57:00
Author DIT Version : 1.0 Page 9/9