Simplified Technical English (STE) and minimalism are of great importance in writing user-friendly documentation, particularly for user content such as maintenance manuals. However, many technical writers experience specific problems when implementing STE and minimalism. The ASD-STE100 Specification is a complex document, and a disadvantage of this approach is its expensive learning time. Plus, literature about minimalism comprises complex documents, and training is scarce.
In this article, we’ll clearly describe the steps you need to take to implement the principles of Simplified Technical English and minimalism in designing optimized, user-friendly documentation. First, we’ll cover the concepts behind the Thumbs-Up Technique—principally, STE and minimalism. Next, we’ll detail the steps to follow in implementing STE. Finally, we’ll detail the steps to follow in implementing minimalism. By following the steps we’ll outline, you can apply the principles of STE and minimalism to your documentation quite easily. Read More
In this column, instead of talking about one of my usual topics—tactics to avoid errors—I’ll discuss how to work within constraints and pragmatically address real-world issues. During the software-development process, your team may ask you to design an error message. Annoying edge cases all too often pop up—usually too late in the process to fix the issue in any other way.
For starters, I never write what I’d call error messages. Admittedly, I occasionally use that term—in the same way I might use words such as sitemap—just at the beginning of a conversation to orient everyone to my process. Just as I did in the title of this column. But I then switch to a more meaningful term and get everyone to talk about exception messages. Read More
The profession of technical writing is on the verge of obsolescence! If you are a technical writer, you need to open your eyes to this reality. The current industry trend shows that hiring managers are looking for people who can fill more than one critical role. With many programmers, quality-assurance testers, analysts, and consultants taking on technical writing, it will eventually become impossible to sustain a career solely as a technical writer without any hands-on technical or analytical experience.
To survive in the ever-changing IT industry, it is essential that technical writers keep honing their skills to avoid becoming dispensable. As the saying goes, it is never too late to learn something new. In this article, we’ll describe some of the proficiencies you should consider acquiring in addition to your technical writing skills. Read More