Re: Describing field meanings and instructions

Subject: Re: Describing field meanings and instructions
From: Bernd <Hutschi -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 22 Oct 2015 17:54:37 +0200

Hi,
we have different kinds of manuals.
There are step by step instructions and general overview information in the User manual and field descriptions and set-up information in the separate reference manual. So each module has a user manual and a reference manual.
All manuals have a manual designed index and a full text search, as well as table of context.

Additionally there are other kinds of manuals, not on topic for this question.

Best regards
Bernd

Am 22.10.2015 um 16:58 schrieb Cardimon, Craig:

Excellent question. I will be following the responses.

~Craig

-----Original Message-----
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Lesli Ritchie
Sent: Thursday, October 22, 2015 9:36 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Describing field meanings and instructions

I always struggle with this one. Our software User Guides describe all the fields on a screen and give the user step-by-step instructions on how to do something, such as add a new record. I usually add a table that describes the fields and their options in the context of the steps, but I feel that this breaks the flow and could be confusing to a new user (our users have a wide skill range). How do you handle this? Do you reference a table of field descriptions within the instructions and then add it to an Appendix? Do you keep it in the instructions? I'd be grateful for ideas.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Describing field meanings and instructions: From: Lesli Ritchie
RE: Describing field meanings and instructions: From: Cardimon, Craig

Previous by Author: Re: Font vs. Typeface
Next by Author: Re: writing for translation
Previous by Thread: RE: Describing field meanings and instructions
Next by Thread: Re: Describing field meanings and instructions


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads