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.
RE: Which is better for simple online help, more or less nesting, moreor fewer hyperlinks?
Subject:RE: Which is better for simple online help, more or less nesting, moreor fewer hyperlinks? From:"Porrello, Leonard" <lporrello -at- illumina -dot- com> To:'Gene Kim-Eng' <techwr -at- genek -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 13 Dec 2011 15:27:19 +0000
Sorry I wasn't clear. Yes, it has those.
From: Gene Kim-Eng [mailto:techwr -at- genek -dot- com]
Sent: Monday, December 12, 2011 7:06 PM
To: Porrello, Leonard; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Which is better for simple online help, more or less nesting, moreor fewer hyperlinks?
I don't suppose it's possible to code the GUI to enable a nested TOC to expand and contract with +/- switches...?
----- Original Message -----
From: "Porrello, Leonard" <lporrello -at- illumina -dot- com>
>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
>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. http://www.doctohelp.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-