[Bf-docboard] Being involved In documentation

reiner.prokein reiner.prokein at posteo.de
Tue Jan 20 09:19:14 CET 2015


Hi,

I haven't followed the whole discussion. So apologies when this point 
was already risen somewhere. But is there a golden rule set to follow 
somewhere? Like a tool description needs:

- short explanation what it does
- menu location, where to find (with screenshot?)
- hotkey
- accessible in which mode
- description how to use
- a short use case with screenshots. (A short video would imho be even 
better)
- special notes

In short, is there something like a official form somewhere that writers 
can follow? I think this would make the whole thing more homogenous. And 
easier for the writers.

Kind regards

Tiles


More information about the Bf-docboard mailing list