Achievo/Manual/Style Guide

Introduction

The purpose of writing documentation for the Achievo Project, is to create for all the users, a complete, well organized set of documentation for each and every module of the Achievo project. In order to achieve this goal, we have drafted the following guide to help.

This document is very new, and at the moment, very sparse.

If you have comments or additions, please do not hesitate to suggest them on the forum.

Consistency

All dates which are part of the text of your document should be spelled out i.e. “March 2, 2000”

This is the only way to be sure that “03/02/2000” is interpreted correctly in all languages, and by all readers.

Spell things according to Standard American spelling, except for proper names, places, etc.

Make sure to set your spellchecker to US English. Make sure you use your spellchecker.

If there is a non-English word, which is used in an English sentence, be sure to spell this correctly, using appropriate accent marks, and any special characters. Use the KCharSelect application if you don't have the correct keys on your keyboard.

Abbreviations should be capitalized, unless they are specifically intended to not be capitalized. (i.e. is a good example).

Punctuation within numbers should be Americanized: 10,000.00

It is more legible to use written numbers where the number has no technical value, e.g. “There are three buttons on the screen”. In this context “3” is not technically significant. Numbers with technical significance should be written as figures. (i.e. “a 10 MB file”, not “a ten MB file”.)

Screenshots

Do only use PNG and JPEG (preferably PNG).
To give our documentation a corporate look we have decided on ONE theme for all screenshots: steelblue
Try to keep to or under 20 KB when saved as PNG.