Okapi Framework - Developer's Guide
Help Authoring Guidelines
When writing the help documents that go along with a module of the framework, you should try to adhere to the following guidelines to allow a more consistent user experience:
Use the common CSS stylesheet
help.css file located at the top
help directory structure. Use a relative path to point to it.
<cite> for any text referring to a text of the
Example: The Custom sub-folder option.
<i> for resource property names.
Example: The approved target property.
<kbd> for key names.
Example: The shortcut is Ctrl+O.
<code> for any text referring to a source code, paths,
<code> for any text referring to a source code.
<b> for emphasis. Be careful not to emphasize too
Example: This is important.
Use relative path for links whenever possible.
Use slashes ('
/') not backslashes ('
\') in the
Whenever possible use the terminology already in used in the other parts of the framework's documents. This avoid misunderstandings and help in getting a better view of the big picture.
Many terms are defined in the Glossary section of this guide. Use them.
Use the US English spelling.