Maybe what I said was misunderstood. When I speak out against
verbosity I mean the following:

- Is it needed to achieve 100 % comprehension? Write it!

- Is it not needed to achieve 100 % comprehension? Forget it or put it
somewhere else.

It's not so much about what to put in and more about what to leave out.

Have a look at these random (well...) professional documentation
examples and read some paragraphs:

http://manuals.info.apple.com/en_US/iPod_classic_160GB_User_Guide.pdf
http://support.apple.com/kb/HT3739

This language is simple, clear and not redundant. There are summaries
and highlighted words to allow easy navigation and quick visual
scanning. The only thing that should be different for BoltWire is the
language coolness and fun factor. BoltWire is not a corporation.
Therefore we can make funny examples instead of serious ones. And we
can be slightly less neutral in expressing things.

Verbose language is "more language" than needed for 100 %
comprehension. The effect?

You spend more time READING documentation instead of USING BoltWire.

And I bet that more verbose documentation means fewer people reading
it and even fever people understanding.

Markus

-- 
You received this message because you are subscribed to the Google Groups 
"BoltWire" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/boltwire?hl=en.

Reply via email to