Re: Which is better for simple online help, more or less nesting, moreor fewer hyperlinks?
A colleague and I are both writing online help for various products. I just noticed that while he is using a TOC structure that includes more nesting (and several levels), I am using a TOC structure that is more flat (featuring only two levels). Following are examples of what my TOC structure would look like using each approach. As you are looking, keep in mind that the application is straightforward and that everything at my level 1 (short of "File Types," "Technical Assistance," and "Revision History") appears on the first screen of the GUI. I think more nesting would be called for were I documenting a more complex application or if the online help were more complex or lengthy. Finally, I should also add that I don't prefer one approach over another and would do whatever is best for the user.
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
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
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com
To subscribe, send a blank email to techwr-l-join -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
- RE: Which is better for simple online help, more or less nesting, moreor fewer hyperlinks?, Porrello, Leonard
Re: How/where would you handle this documentation problem? (david hendler): From: Chris Despopoulos
Which is better for simple online help, more or less nesting, more or fewer hyperlinks?: From: Porrello, Leonard
Previous by Author:
Re: Re: Can you figure out what tools produced a PDF?
Next by Author: Re: what doc formats do READERs want ?
Previous by Thread: Re: Which is better for simple online help, more or less nesting, more or fewer hyperlinks?
Next by Thread: RE: Which is better for simple online help, more or less nesting, moreor fewer hyperlinks?
Search our Technical Writing Archives & Magazine