The Importance Of Interface Text (part 1) - The First Date (
Page 3 of 5 )
In a software application,
just like for code, there are front-end and back-end documentation requirements.
Note that when I use the term "documentation", I am referring to all text-based
inputs into the application.
The back-end documentation is so-called
"facilitating documentation", which is usually never delivered to the user -
this would include the requirement specification and the design specification.
On the other hand, front-end documentation is developed for the user and
includes:
- Reference documentation like software technical reference manuals
- Support documentation like user manuals, online help and installation guides
- Interface text, or the labels that appear on the user interface (which also
happens to be the subject of this article)
While each kind of
documentation makes its own indispensable contribution to the application,
interface text is like the first date that decides whether or not the user would
like to take the relationship further. All the brilliant code that has gone into
the application is put paid to if the user can't understand what a screen is
supposed to do.
Interface text includes:
- Titles
- Field and button labels
- Instructional text
- Error messages
- Confirmation messages
It should be noted that the above refers to
text seen by a user only. There is, however, usually also a separate text-based
deliverable, application messages, which includes the text displayed at the time
of installation/configuration, console-based messages, e-mail notifications and
reports sent by the application to the administrator. The audience for this
deliverable is not usually the non-technical user, but the more savvy
administrator, and this interface text is different from the rest in that it
requires accurate technical understanding and allows for a greater degree of
technical jargon.
/ 4 
