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.
I think that's a straw man. Task-oriented documentation can and should
be comprehensive. Any UI text that's not self-explanatory can and
should be explained somewhere. That doesn't mean you need a topic for
every dialog box, but neither does it mean some topics won't be about
one dialog.
Context-sensitive help should go to the topic you think users are most
likely to be looking for, and that topic should have links to any
other topics relevant to the context.
Task-oriented documentation pretty much always needs to include
reference topics for things such as APIs and configuration files that
are not task-specific.
I stopped upgrading Paint Shop Pro because the UI got overly complicated.
On Fri, Aug 8, 2014 at 3:50 PM, Mike Starr <mike -at- writestarr -dot- com> wrote:
> The current received wisdom within the technical writing community is that
> we must focus on task-based documentation... give the users instructions for
> the most common tasks they might want to perform. Overall, I agree with the
> need to provide task-based documentation but I disagree vehemently with the
> position that we don't need to provide reference-based documentation.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l