TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
If this *were* task-based, and the task was filling out a form for an
initial configuration, then I'd use the "tab" order of the fields.
Documenting self-explanatory UI elements such as "path" or "file name"
is clutter unless there's some value to add to what the user sees in
the UI. E.g. "file name: the name of the file" is clutter, but "file
name: 128 characters max." might be useful.
On Wed, Sep 23, 2015 at 12:34 PM, Mike Starr <mike -at- writestarr -dot- com> wrote:
> It's not always all about task-based documentation. There is a time and
> place for reference documentation. At some point, users need to be able to
> understand every UI element even when we don't provide them with
> documentation for a task that uses that particular element.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW
