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.
> I don't approve of the kind of documentatíon where
the writer merely writes that you *can* do this or that, but not describes
the different settings and commands and the consequences of pressing
different buttons or selecting different options.
Let's get specific here. My chapter 1 is Using the System, chapter 2 is
Using the Interface.
1 is task based, 2 is dialog based. 1 refers to 2 more than 2 refers to 1.
You NEED both, but if I catch ANY of you giving me another explantion of how
to use a damn spin control or set of radio buttons I'll hijack the next
flight outa here and come SPANK YA BUTT HARD!
Now, properly assumed, nesting is shallow for tasks. Diversion might be
hefty but you link to sequential topics AT THE SAME LEVEL so nesting is
shallow. What you really need to do is provide a set of overview diagrams
graphically breaking this stuff down visually for people to garner as
Additionally, something like
1.1 Getting Started
etc is always an option as well. Define flow areas with common boundaries
and chunk accordingly. In this way, 1.7 would normally be 7 levels deep!!!
Now chapter 2. Again, properly assumed, the subjects can be gathered by type
making a very shallow structure:
File A pen
blah de blah. Its not a great one for your complexity, but never-the-less
this technique can be applied at any level.
Juz some thoughts to help the ole lateral bits chuck a beaut sideays burnout
up memory lane n all...
Steve Hudson - Word Heretic, Sydney, Australia
Email: heretic -at- tdfa -dot- com Blog: www.tdfa.com/blog/blog.htm
For MS-Word questions please use msnews.microsoft.com before
heretic -at- tdfa -dot- com -dot-
You agree by writing to me personally that any material from this message
can be reused publicly unless you explicitly disclaim all or part of the
From: Broberg, Mats
Anywya, here's where I need you input. I have gotten rid of the deepest
levels of headings by arranging the information in tables (in a sort of
InfoMap arrangement), but I still need about 8 levels of headings. I know
what you think, and no, the software that I am describing can not be
designed in a simpler way! :)
I am using incremental numbering for the headings, due to the fact that I
believe that it is wiser to differentiate deep levels of headings merely by
a number whilst keeping the same typeface and size for these deep levels. By
looking at the number the user can immediately see where he or she is in the
tree structure. I printed out a series of different arrangements where I was
differentiating the typeface, weight, and style actually gave the pages a
more messy look (they have alot of tables and figures, too). At this time,
H1, H2 and H2 are differentiated typographically (they have numbers too),
while H4-H8 are set in a 10 pt sanserif and differentiated with the
incremental number only.
Any suggestions how to solve this conundrum in a different way?
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.