KISS Principle of Simplicity
The KISS principle is not exclusive to technical writing. It is a general engineering principle, which suggests that any hardware or software created by humans is more reliable and easier to maintain and enhance if its complexity is deliberately minimized. This principle is humorously contradicted by the Shadocks’ saying: Why keep it simple when you can keep it complicated?
This principle was crucial in the design of Swatch watches, whose specifications required them to contain half as many parts as their counterparts. The result: watches that are less expensive, more reliable, and available in a variety of ever-evolving versions.
What has proven successful for watches can be applied equally well to technical documentation. Regardless of the format used, the technical writer can either construct a document that is elegantly structured or overly complex. With DITA XML, one merely needs to avoid centralizing conrefs or over-nesting them. With FrameMaker, it’s even simpler, as the lack of safeguards can lead to an unmanageable document if styles and overrides are multiplied excessively.
Similarly, when crafting sentences, the technical writer must always keep the KISS principle in focus. It’s easy to create complex sentences that often indicate a lack of understanding of the subject rather than refined writing. Constructing a simple sentence requires an effort to grasp the subject matter. Once understood, it becomes easy to write content that is clear to the reader. This is a core aspect of a technical writer’s role. The technical writer adds significant value to the product being documented.