Expert Python Programming - Third Edition

Use a simple style

Simple things are easier to understand. That's a fact.

By keeping sentences short and simple, your writing will require less cognitive effort for their content to be extracted, processed, and then understood. Writing technical documentation aims to provide a software guide to readers. It is not a fiction book, and should be closer to your microwave operation manual than to a Dickens novel.

The following are a few tips to keep in mind:

• Use short sentences. They should be no longer than 100–120 characters (including spaces). This is the length of two lines in a typical paperback.
• Each paragraph should be composed of three to four sentences at most, which express one main idea. Let your text breathe.
• Don't repeat yourself ...