Philippe Bossut wrote:
For technical docs, cut the literature and stick to simple writing
rules. I posted something on this some months ago here:
http://wiki.osafoundation.org/pub/Journal/PhilippeBossutNotes/GeorgesSieve.htm
I must have missed this the first time through but this is a great
one-page set of guidelines for technical writing - thanks for writing it
up, Philippe!
For anyone interested in a quick primer (or refresh) on good technical
writing check this out, I found a simple guide to clear, concise writing
style in a strange place: Stephen King's "On Writing" (Yes, that Stephen
King) - all you need to read is pages 111-137, entitled "Toolbox" - its
26 pages of "here are the 4-5 things to always have in mind when writing
anything" - one could probably read it in the bookstore or the library
in 20 minutes. Highly recommended, and I think especially attractive to
geeky people who just want bare advice without a lot of prose.
Alec
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
Open Source Applications Foundation "Dev" mailing list
http://lists.osafoundation.org/mailman/listinfo/dev
