troubleshooting Question

Tech Writing - Repeat same explanation in three related section of document?

Avatar of Stephen Kairys
Stephen KairysFlag for United States of America asked on
Web ApplicationsTechnical Writing
19 Comments1 Solution246 ViewsLast Modified:

I'm documenting a connected series of screens that contains list of geographic locations. There are three screens;
  • Continent
  • Country
  • State

Each geographic entity can be assigned a value. e.g.
  • North America = 3
  • USA = 6
  • Ohio = 4

The returned value is the one for the most specific entity:]
  • If you are in Ohio: 4
  • If you are in the USA but not in Ohio: 6
  • If you are in North America but not in USA: 3
For this document, I have an intro, and then three sections (Continent/Country/State)

Would it be better practice to repeat the above derivation of the returned value in each section (3 instances) or just once (in the intro).  My concern is that if I put it in the intro, and someone is reading only the State section, they'd miss out on this explanation.

What you do think?

Stephen Kairys
Technical Writer - Consultant

Our community of experts have been thoroughly vetted for their expertise and industry experience.

Join our community to see this answer!
Unlock 1 Answer and 19 Comments.
Start Free Trial
Learn from the best

Network and collaborate with thousands of CTOs, CISOs, and IT Pros rooting for you and your success.

Andrew Hancock - VMware vExpert
See if this solution works for you by signing up for a 7 day free trial.
Unlock 1 Answer and 19 Comments.
Try for 7 days

”The time we save is the biggest benefit of E-E to our team. What could take multiple guys 2 hours or more each to find is accessed in around 15 minutes on Experts Exchange.

-Mike Kapnisakis, Warner Bros