Tips
· Practically nobody reads the documentation, from the beginning up to
the end. The user wants to find the answer on the question as soon as possible.
(I never saw, that my wife has read though any part of the instruction of use of
this or that device. In result, she erased not correctly linen within three years,
sentencing, “why is it grey?!”)
· Advice
for writing Help.
· Before compiling Help, become convinced, that your document in a mode
Document Map looks, as you have conceived, and all references in the left panel
are correctly displayed and worked.
· Do not use anything except standard fonts offered by Word - then it is
possible to redefine all through an external css file.
· Don’t use symbol # in names and files path it is not recommended, as
it reserved for definition of bookmarks in URL.
· Do not create a plenty of styles, they ripple in eyes.
· Write short sections that will fit in 1-2 screens of the Help, instead
of 10, otherwise it will be necessary to scroll long text and it forces down from
idea and tires.
· One paragraph for one idea. It is easier for reading and understanding.
· Use short sentences. It allows more clearly to express an idea unequivocally.
Complex sentences, shows that you not clearly understand about what you write.
· Write to one person - not to group. Address to the individual reader
to win his trust and to avoid mess.
· Avoid ambiguity. Avoid phrases such as «Probably, it will be... «. Do
not use double denying.
· Use the simplest style for writing of the documentation. To achieve
the best representation of the Help used an external file of styles. The
printed variant of the documentation also used firm style through Themes or
selection of style in MS Word (the Format / theme …).
· Give the rest to your eyes after each 15 minutes,
look afar 15 seconds, 15 seconds alternately look to the right - left - top - downwards
and - or make circular movements by eyes. Accept a correct pose.
· Over 45-50 minutes of work - get up, walk, and warm up.