Functional Template
De Business Process Management, BPM and Workflow Automation Wiki | BizAgi BPMS
Contents |
Functional Template
The entire documentation process is a response to the user's need to fill a gap as regards knowledge in a certain area.
When interacting with BizAgi, end users (expert or not) expect to find a solution in the documentation as regards their concerns and any problems that may arise. Users' basic concern is: ¿How do I use this functionality, this program?
Before starting to write or document a BizAgi functionality, we have to put forward the solution to this basic question, to describe the information that is going to be defined in each BizAgiWiki article in an organized, coherent fashion.
If we create organized, clear, complete documentation, we avoid processes of repeating information, save time on this type of activities and provide assistance as regards support topics, training for external or internal users.
The following template is a guide to document and arrange the information of a functionality in a BizAgiWiki article. In addition, the BizAgiWiki User’s Manual can be used as a guide, along with the Best Documentation Practices Bizagiwiki_manual y Best Documentation Practices to structure the contents of BizAgiWiki.
- 1.1. Name of the functionality.
- 1.2. Summary.
- 2.1. Context. Describes the context and origin of the functionalityFor instance, it can identify the business objectives that are satisfied or the problems solved by implementing it.
- 2.2. Description of the functionality.. The description can contain examples when required due to complexity.
3. Activities
- 3.1. BizAgiStudio.Contains the steps to be followed in order to set up the functionality or use it in BizAgiStudio. These steps go along with images. Considering the Wiki languages and structure, the person creating the documentation should make his/her best effort for the images to be as appropriate as possible.
- 3.2. Web Application. Contains the steps to be followed to execute the functionality in the web application. These steps are followed by images. Considering the Wiki languages and structure, the person the person creating the documentation should make his/her best effort for the images to be as appropriate as possible.
4. Setup and Requirements
Contains links with the respective description of the information regarding the configuration outside the functionality. For instance, if you are documenting the sending of mail, it could have information on how to set up the SMTP server.
Contains information on special setups in which behavior other than normal behavior is expected. For instance, when a functionality should not be used within grids.
Contains the references (links) of other BizAgi functionalities that may be of interest to the user who is reading the article.
