Archive for July 2010
Use Case and the Importance of Storytelling in Technical Documentation
© 2010 Ugur Akinci Software and hardware developers are well-educated intelligent engineers who usually have no difficulty at all in creating products. The real difficulty in product development is not the question of “how” (as in “how can we build this?”) but “what” (as in “what shall this product do?”). Just like in screenwriting, the…
Read MoreWrite Your Technical Documents with Consistent Tense
© 2010 Ugur Akinci Don’t go time-traveling from one clause to another. If you have multiple clauses in a sentence, try to make sure their verbs are in the same tense. EXAMPLE: “The circuit started to overheat [PAST] when the operator shuts down the relay [SIMPLE PRESENT].” BETTER 1: The circuit started to overheat [PAST]…
Read More