UXmatters has published 42 articles on the topic User Assistance Design.
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
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
Tables get a bad rap—especially in the Web world where, once upon a time, Web developers misused them for HTML layout. But tables are still very useful for the purpose for which they were originally intended—a way to show relationships among discrete data points. From a user assistance perspective, we deal with tables in two contexts:
In this column, I’ll review some of the basic principles of good table design from an information developer’s perspective, then discuss their visual design and interactivity. These principles and my examples provide the bare essentials of table design. When designing tables, a key information design objective is keeping them simple, so if you start needing more than this column provides, you might be making things unnecessarily complicated for your users. Read More