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.
Links to related topics. Relationship tables or topic-by-topic lists?
Subject:Links to related topics. Relationship tables or topic-by-topic lists? From:Andrew Harvie <withanie -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 2 Oct 2012 16:00:11 -0300
G'day all.
Currently building a new project using Flare. For lists of related
topics, I'm weighing the merits of using relationship tables versus
putting links into each topic. Both techniques seem to have their
merits. The links are certainly easier to manage when adding a new
topic to the list is as easy as updating a row instead of adding a new
item to the list in X separate topic files.
Somewhat complicating my design is that for tasks, I want to provide
a list of next steps (task-related topics to read next, if any).
These are almost always specific to the task just completed, so I
can't see them fitting into a rel-table nearly as well as, say, a list
of vaguely-related tasks. It seems a bit ugly to create a hybrid of
links from a rel-table and topic-specific links, but maybe that's the
only way?
So, relationship table or topic-by-topic list of links to related
information. Which do you prefer and why?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.