Describing field meanings and instructions

Subject: Describing field meanings and instructions
From: Lesli Ritchie <Lesli -dot- Ritchie -at- mediware -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 22 Oct 2015 13:36:13 +0000

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 |


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 for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @


Previous by Author: Partial Screenshot Indicators
Next by Author: Re: Post about a creative writer who went into tech writing for a spell
Previous by Thread: Re: most effective method for SME review?
Next by Thread: RE: Describing field meanings and instructions

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

Sponsored Ads