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.
They say there is no such thing as a dumb question
Subject:They say there is no such thing as a dumb question From:Roberta Hennessey <rahennessey -at- gmail -dot- com> To:tech writer tech writer <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 10 Jan 2011 15:20:21 -0500
I hope this is not the first dumb question. Snide comments not taken
I am being asked to scope out a project - documenting an online help for a
GUI application. I have used
Webworks to create online help from an existing document (Frame or Word),
but I have never created help
for a GUI that is already in place. The GUI application is done in Java but
no one here uses the Doxygen method,
etc. and there are no plans to do so.
I think the documentation will be relatively simple - but I'm not sure what
type of tool would work best for this
group, and which one would be one they could upkeep. I imagine it will be
process of mapping the context
sensitive help to locations in the GUI.
Any books, blogs, websites, ideas from anyone on how to begin to scope this
effort? Any and all advice
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-