software documentation

From the book Expert Python Programming, “Documenting Your Project“, “Use a Simple Style“:

You are not writing fiction, so keep the style as simple as possible.

And with a few more words:

(Another author) made an analysis […] to try to understand, why his books sold so well. He made a list of all best sellers in the marketing area and compared the average number of words per sentence in each one of them. He realized, that his books had the lowest numbers of words per sentence (thirteen words). This simple fact […] proved that readers prefer short and simple sentences, rather than long and stylish ones.

This site uses Akismet to reduce spam. Learn how your comment data is processed.