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.
Subject:Re: The Works From:Gregory P Sweet <gps03 -at- health -dot- state -dot- ny -dot- us> To:Becca <becca -at- di -dot- org> Date:Wed, 15 Aug 2012 09:21:24 -0400
For us "the works" would include everything already suggested (printed,
PDF, help files) as well as self-paced and live training courses.
Self-paced might include workbooks, videos, and simulations. Live course
would be delivered via WebEx and certainly include workbooks, demonstration
and hands-on-practice. And I've just begun exploring Aurasma to add
extended content to our documents.
I won't go so far as to say augmented reality, because IMHO that would need
to lay practical information over everyday objects. My idea is to extend
the content by using the screen caps in the docs as tags to load the video
demos. That is, if you are not getting something from the text, point your
phone's camera at the screen cap and see it demonstrated.
techwr-l-bounces+gps03=health -dot- state -dot- ny -dot- us -at- lists -dot- techwr-l -dot- com wrote on
08/14/2012 08:44:25 PM:
> From: Becca <becca_price -at- yahoo -dot- com>
> To: tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
> Date: 08/14/2012 08:44 PM
> Subject: The Works
> Sent by: techwr-l-bounces+gps03=health -dot- state -dot- ny -dot- us -at- lists -dot- techwr-l -dot- com
> I'm on the edge of starting an independent contract, documenting the
> interface to a fairly involved database. There will be 2, maybe 3
> groups of users, none of whom can know anything about the other
> groups. When the person who is creating the database and the
> interfaces pitched the idea of documentation to his end-cllients,
> they got all excited, and now say they want "the works" - help
> files, PDFs, and what ever else I can think of that would be useful.
> (I am under an NDA so I can't talk more about the end product.)
> I figure separate help files for each user group, and printable
> reference manuals, but other than that, I'm not sure what "the
> works" entails. Any suggestions, please, for additional
> documentation that would be useful?
> I own Flare 8 for the help files, and have Acrobat X Pro to help
> with the pdfs.
> This is my first independent contract after being out of work for
> several years (and after going back to school to upgrade my
> technical skills). I want to make sure to do an excellent job on
> this, and cover all possible bases.'
> Thanks for any advice you can give me!
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.