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.
Our default help format is based on task instructions, with a "How do I...?"
section upfront for the most common tasks. On models intended for "advanced"
users, there are "Learn more about.." links at the bottom of each task
instruction that jump to explanations of concepts and/or best practices for
special operations that require unusual combinations of tasks, such as how to
manually configure if you're trying to use the product with a system that its
auto-configure hasn't been designed to be compatible with. Most of these aren't
in the help at all, but are online.
Gene Kim-Eng
----- Original Message -----
From: "John Posada" <jposada99 -at- gmail -dot- com>
> For instance, I'm proposing the premise that since this is for a
> support site, we should be doing less explaining issues compared to
> more presenting procedures on how to do and fix things; the logic
> being that the average telephone customer doesn't care as much about
> how something works as they do with getting it to work so they can
> make their call and get on with their life.
>
> Keep in mind, I'm not writing for the techy geek, but for the average
> Joe Q Public with a telephone.
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-