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:
user assistance—Tables can present information or instructions in our documentation.
user interfaces—Tables can display information within a user interface itself.
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
Many Web application designers strive to reduce the amount of instructional text that appears in the user interfaces they create. A likely part of their motivation is the perception that, if explaining how to use something requires too much instruction, it probably isn’t that easy to use and, therefore, has room for improvement in its design. Another motivating factor might be the tendency for people not to read any on-screen instructions, just like they tend not to read product manuals.
This type of thinking also applies to Web forms. When possible, designers strive to utilize a minimal amount of text to explain how users should fill in the different input fields in a form. In cases where forms absolutely require additional explanations or examples, a bit of clear text adjacent to an input field tends to do the trick, as shown in Figure 1. Read More