Edit online

Index terms

Index terms should not start with the product name, for example if the product name is oXygen or SyncroSoft, do not use

oxygen validation

as index term, use simply

validation

without mentioning the product name because that will not be relevant, as the product is already the context for the index term.

Rule
avoidWordInElement
element
indexterm
word
oXygen
message
Do not use oXygen in index terms!

Author information

Record the author of each topic using the author element inside the topic prolog.

Titles and short descriptions

Titles should not be very long, we should keep them less than 10 words.

Rule
restrictWords
parentElement
title
minWords
1
maxWords
10
message
Titles should not be long, keep them less than 10 words.

Short descriptions should be less than 20 words and also less than 160 characters so we can use them easily with twitter.

Rule
restrictCharacters
parentElement
shortdesc
minChars
1
maxChars
160
normalize
yes
message
Short deascription shopuld be used on twitter so we need to keep them less than 160 characters.