1= MYMODULE =
2:subtitle: MYMODULE DOCUMENTATION
3:source-highlighter: rouge
4:companyname: __MYCOMPANY_NAME__
5:corpname: __MYCOMPANY_NAME__
6:orgname: __MYCOMPANY_NAME__
7:creator: __USER_FULLNAME__
8:title: Documentation of module MyModule
9:subject: This document is the document of module MyModule.
10:keywords: __KEYWORDS__
11// Date du document :
12:docdate: __YYYY-MM-DD__
13:toc: manual
14:toc-placement: preamble
15
16
17
18== TOPIC OF DOCUMENT
19
20This document was build from following input:
21
22* Date 1
23...
24
25* Date 2
26...
27
28
29The document includes an introductory chapter of functional specifications, presenting the different actors involved in the rebuild of the definitions
30of business terms that will be used (some of which may be new or different).
31The main following chapter will present the entire process, also known as *uses cases*, according to a principle of a description, in chronological sequence if possible,
32to present the actor and the action performed, as in the following example:
33
34* *X* Actor realizes Action A.
35* *Y* Actor communicates Info B to Actor *Z*
36* *Automaton* performs update of data for...
37* Etc ...
38
39Functional requirements are complemented by a chapter of technical requirements.
40The chapter on data lists key information specific to Presto that were identified at the time of writing specification. It will be enriched as
41iterations occurs.
42
43Finally, in the Appendix, the documents known when writing this document are centralized to illustrate the existing document or inspire the new expected one.
44These documents have their content directly integrated in this specification or have a reference to
45external documents stored in the *Appendices* directory accompanying this document.
46
47
48
49*Log of versions*
50
51[options="header",format="csv"]
52|===
53Author, Date, Version
54--- __USER_FULLNAME__  __USER_EMAIL__ ---, __YYYY-MM-DD__, Version 1.0
55|===
56
57
58
59<<<
60
61
62== BUSINESS SPECIFICATIONS - INTRODUCTION
63
64=== List of actors [[actors]]
65
66Actors are physical people or moral entities working on at least one process.
67The following chart prensts list of actors or partners identified by the project for the defined scope of project. We will use then the name defined into first column to speak about roles in the rest of documents.
68
69[options="header",format="csv"]
70|===
71Actor/profil/role, Description of role, Access to system or not, Example of actor
72Customer Service, Receive and create Sales orders (SO), Yes, Mr Smith
73Purchase, Make puchase order (PO), Yes, 5 people
74Administrator - IT, Administration of users/groups and IT services, Yes, John Doe
75Automaton, Execute automatic data processing, Yes, NA
76|===
77
78
79=== Definitions [[definitions]]
80
81To understand the descriptions of the target process, it was necessary to define or redefine some vocabulary concepts. We must see these definitions as defined in the
82new system. Indeed, some terms are already being used but have either not a definition in line with standards, or even differs between services. To bring everyone,
83and to consolidate the process, these terms are redefined here, and with their definition in the target objective.
84
85*Definition ABC*
86
87...
88
89*Definition DEF*
90
91...
92
93
94[NOTE]
95==============
96Important information will be noticed with a notice like this one.
97
98* Main information 1
99* Main information 2
100==============
101
102
103
104== BUSINESS SPECIFICATION - PROCESS
105
106Specifications were cut into different business process. We call a business process a workflow with a starting situation and ending situation. Between start and end, we will find actions
107done by actors to bring the value of the company. This actions are described using the syntax rule:
108*Actor X* do action Y, *Actor Z* do action W.
109
110_Each process/use case is described into a separate chapter._
111
112
113=== Use case / Process 1 [[process_1]]
114
115==== Title and goals
116
117...
118
119==== Actors or roles
120
121* Members of group *...*
122
123==== Standard flow
124
125* Members of Groupe *...*: Do ...
126* Members of Groupe *...*: Do ...
127* Members of Groupe *...*: Do ...
128
129==== Alternative flow
130
131* A user without role *...*: Can't do ...
132
133==== Business rules
134
135* Business rule 1
136* Business rule 2
137
138
139