Guide for documentation writer - Samsung/Tizen.CircularUI GitHub Wiki
Welcome to the Tizen.CircularUI wiki!
If you are a documentation writer, follow the guide of doc team.
- According to the checklist we don't use the word "Please" and "below" in the technical document.
- AS-IS : For more information. Please refer to below links
- TO-BE : For more information, see the following links:
- Remove space between word and semicolon.
- AS-IS :
Command
: Gets or sets the - TO-BE :
Command
: Gets or sets the
- Space missing after text before (
- AS-IS : to be invoked on activation(item clicked).
- TO-BE : to be invoked on activation (item clicked).
- change "the user" to "you"
- AS-IS : allows the user to select a value
- TO-BE : allows you to select a value
- according to our checklist we avoid using gerund (ing) in the heading. The main reason to avoid usage of gerund in the sentence is that during translation the meaning of the word will change.
- AS-IS : ## Adding CircleStepper at CirclePage
- TO-BE : ## Add CircleStepper in CirclePage
- Remove 's
- AS-IS : This guide's code example uses WearableUIGallery's TCCircleStackLayout code.
- TO-BE : The code example of this guide uses TCCircleStackLayout.xaml code of WearableUIGallery.