Bizagiwiki manual
De Business Process Management, BPM and Workflow Automation Wiki | BizAgi BPMS
Contents |
BIZAGIWIKI USERS MANUAL
The BizAgi documentation has grown and changed in such a way that it has now led us to a new stage, where content creation and editing will be in the hands of everyone involved in the development and implementation of the product.
The Wiki tool is a new challenge to construct interactive, educational, functional and useful documents together for the people who want to get to know and understand the BizAgi world.
This document is meant to provide the basic tools and procedures to document BizAgi and generate, edit and search BizAgi contents in Wiki.
Getting to Know Wiki
Wiki technology enables websites on a public server (the wiki pages) to be written in a collaborative manner by means of a browser using simple notation to serve as a format, create links, etc., conserving a history of changes to easily recover any previous state of the page. When someone edits a wiki page, the changes appear on the web immediately, without undergoing any sort of review.”
The BizAgi Wiki home page is: http://wiki.bizagi.com/
And it can be divided into three sections:
Left Column: the following is a description of the most relevant characters:
Main Page: Presents the home page of BizAgi contents.
BizAgi: This is a link to the official BizAgi site.
Search: This option generates the content queries carried out.
Language: When you click on the flag icon, the BizAgi contents in Spanish/English are presented in parallel.
Special Pages: Shows a list of topics that we will use to upload images, see update history and other categories for the use and maintenance of contents in Wiki.
Top Menu: the following is a description of the most relevant characters:
Edit: when you click on this option, an editor appears for you to make changes to the content that has been generated.
History: shows a history of the updates carried out, specifying the dates upon which the changes were made and the users who made the modifications.
Search: This option generates the content queries carried out.
Create account: This option enables you to create a user account so the content updates are later recorded for the maintenance and translation of changes that are approved.
Home Page: The BIZAGIWIKI home page brings together all relevant documents and information related to BizAgiStudio. The following is a description of the most relevant characters:
BizAgi Studio 9.0: This section links us to the BizAgiStudio User’s Manual in Spanish and English.
BizAgiStudio Characteristics: Initially, this section will only have the Release Notes and Glossary option enabled and is meant to include information that will serve as a feedback and support mechanism for the main BIZAGIWIKI documents. There will be options such as FAQs, suggestions and business tips available her.
BIZAGIWIKI Change Control: This is the procedure that all BIZAGIWIKI users must take into account to create, edit or consult information relating to BizAgiStudio.
BIZAGIWIKI User’s Manual: This document describes the BIZAGIWIKI functionalities by presenting their most representative characteristics and element to be taken into account to make best use of them.
Best Documentation Practices: This document introduces certain guidelines and recommendations for best documentation in BIZAGIWIKI.
Wiki Tools: This option shows the most visited and searched BIZAWIKI pages.
How to Create an Account
A user account in BIZAGIWIKI will give us access to documents associated with BizAgi for consultation and editing purposes, and it will also enable us to administrate the updates made by each of the users in an efficient manner.
1. At the top right hand of the screen, click on the log in / create account link and register in each of the screens.
|
Note:When you create the account, use a Username that will identify you. For instance, Alfonso Ordoñez (Username: Alfonsoo). This recommendation is useful for content change control, history management and subsequent translation of the updates by the BizAgiWiki administrator. |
2. After you create your account in Wiki, you can go to the BizAgiWiki documentation to search the contents or modify them.
|
Note: if you have not created an account, you can view the information but you cannot make any changes to the contents. |
3. Click on the Main Page option in the left column and select the main content you want to enter. At the present time, you will find product user manuals, BIZAGIWIKI change control, the BIZAGIWIKI user manual, and best documentation practices, among others.
How to Edit an Article in Wiki
Editing and creating contents enables us to add the documentation of new functionalities or complement or change contents of existing functionalities.
Before editing an article, we have to enter with the respective username to be able to make the changes.
|
Note:Initially, editing and updating contents in BizAgi Wiki can only be done for the BizAgi Studio 9.0 Manual in Spanish; the base document for subsequent translations. The BizAgi 9.0 Manual in English will be available as a reference but the recommendation is Not to make any changes to the document. |
1. Enter the page or article you would like to change.
2. Select the Edit tab on the upper menu of the BizAgi Wiki site. The corresponding editor will pop up where you can change or enter new contents, screens, tables and images.
The editor has a toolbar that will help you create, update and organize the information in the article.
The most representative elements of the editor toolbar are:
Wikitext: Shows a view of the wiki code of the current page.
Form: This option enables you to establish defined forms for the different types of titles or headings. There are currently 5 types of titles to structure and organize a document depending on the levels you would like to use.
Find and replace:Use this option to find and replace words..
Insert/Edit Table: This option enables you to add or edit a table..
Insert/Edit Image: This option enables you to add or edit an image. The image must be previously uploaded onto the BIZAGIWIKI site using an image editor. (see How to Upload an Image).
Insert/Edit Link: Enables you to insert or edit a link. Links can only be generated if the target document has already been created.
3. When you have finished making the updates, there are buttons at the end of the editor page to Save the changes made and view the changes before saving them..
|
Tips |
|
|
How to Create a New Article
There are two ways to create a new document in wiki; using a new link and carrying out a query.
Before editing an article, we have to log on with the respective username to be able to make the changes.
1. Log onto the page or article you want to change.
2. Click on the Edit tab on the Top Menu of the BizAgi Wiki site.
3. Click on the Insert/Edit Link option on the editor toolbar, and enter the name of the new article in the window that is displayed, and click on the Save Page button at the end of the editor.
4. Select the link of the new article you have created and access the wiki editor where you can enter the respective contents and information.
The following is another way to create a new article in wiki
1. In the left hand column of BizAgi Wiki, enter the name of the new article in the Search option and click on the Go button to carry out the query.
2. The link with the name of the new article will be at the top of the page presenting the results of the query.
3. Click on the link of the new article you have created and access the wiki editor, where you can enter the respective contents and information and save the changes.
