Re: Is Search replacing the TOC and Index?

Subject: Re: Is Search replacing the TOC and Index?
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: Julie Stickler <jstickler -at- gmail -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 11 Jul 2014 11:45:04 -0700

A hierarchical page tree (i.e. TOC) is essential for a wiki to be
usable for most types of technical documentation. So is the ability to
restrict control of that tree to trustworthy editors.

That might limit the choices to Confluence and MindTouch. I didn't
find any others when I was researching what was available in early
2012.

A wiki without a page tree might be fine for a knowledge base.

On Fri, Jul 11, 2014 at 7:19 AM, Julie Stickler <jstickler -at- gmail -dot- com> wrote:
> User documentation without a TOC or index is a wiki.
>
> And I don't know about you, but unless I stumble upon the exact title of a
> topic, I tend to have trouble finding what I'm looking for in a wiki... At
> least I've never had much success with finding things in company wikis,
> because they lack organization.
>
> And I see more than enough documentation where when someone says, "this
> needs to be documented" the topic just gets stuck anywhere without any
> thought for how it relates to the rest of the doc and how we as TWs might
> help users find the information via TOC, index, cross-references, etc.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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
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


References:
Is Search replacing the TOC and Index?: From: Andrew Harvie
Re: Is Search replacing the TOC and Index?: From: Paula Cristina Vaz
RE: Is Search replacing the TOC and Index?: From: Cardimon, Craig
Re: Is Search replacing the TOC and Index?: From: Julie Stickler

Previous by Author: Re: Is Search replacing the TOC and Index?
Next by Author: Re: Using jira for documentation development workflows
Previous by Thread: Re: Is Search replacing the TOC and Index?
Next by Thread: Re: Is Search replacing the TOC and Index?


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

Sponsored Ads


Sponsored Ads