Jump to: navigation, search

Changes


Help:Editing

1,041 bytes added, 09:58, 25 August 2015
/* Client articles */
= Client articles =
Features and behavior There are four types of the clients have a rather big overlappages related to client documentation, especially how its documented. Hence* Specifications (technical documentation, it is advised to describe the features in the most general way possible and to specialize only those parts which are platform dependent (due to different UI designs, etc).9* How-Tos* FAQ* Version pages
The approach Documentation related to the different platforms (Android, Windows and Web) should be placed as within those pages as described below. === Specifications === Features and behavior of the clients sometimes have a rather big overlap, especially how it is documented. On the other side, due to different platforms we have varying UI elements in both, form and handling.Nevertheless, documentation should be kept to create a common article for a certain featureminimum and hence, the features described in the most generic way possible. Special Only those parts which are platform dependent (due to different UI designs, etc) should be separated by specialized using tabs for each platform, where an according code snippet for adding tabs can be found here:dependent documentation.
<syntaxhighlight lang="xml">
</tab>
</tabs>
 
=== How-Tos ===
Platform / component specific documentation is to be placed onto distinctive tabs. Hence, the information is placed onto the following tabs
* '''Studio''': describing actions to be performed with UBIK Studio
* '''Android''': describing actions performed in the Android client
* '''Windows''': describing actions performed in the Windows client
* '''Web''': describing actions performed in the Web client
 
=== FAQ ===
An additional tab '''Windows''' is added to the FAQ page for the clients. FAQs related to the Windows client is to be placed here.
 
=== Version pages ===
Separate version pages are created for the Windows client, rather similar to the version pages for Android or the Server.
=Special articles=
10,686
edits