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: Documenting the user interface From:Maggie_Secara -at- capgroup -dot- com Date:Wed, 10 Jan 2007 10:02:05 -0800
Who is your audience? What is the goal? When I "document a user interface"
I'm actually documenting the tasks an end user uses that interface to
perform. In that case, I don't just list every menu item and what it does,
I spend time pushing all the buttons to see what they do, identify tasks,
and write procedures for them. If you're cataloging the UI elements for
some other reason, you may want to go another way.
|--------------------------------------------------------------------------|
| Maggie Secara, Technical Writer |
| The Capital Group Companies | Location: LAO-333 32 | Extension: 92274 |
| Outside: (213) 452-2274 | E-mail: maggie_secara -at- capgroup -dot- com |
| [ Mailing: 333 S. Hope Street Los Angeles, CA 90071 USA ] |
|--------------------------------------------------------------------------|
"Kapoor, Shelly" <SKapoor -at- imf -dot- org> wrote on 01/10/2007 09:32:59 AM:
> I have to document a couple of user interfaces. What do you thin is the
> best way to proceed? Could you please point me to some tips/ideas for
> documenting user interfaces.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-