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: How/where would you handle this documentation problem? (david hendler)
Subject:Re: How/where would you handle this documentation problem? (david hendler) From:Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com> To:"techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sat, 10 Dec 2011 08:55:35 -0800 (PST)
I would use customer release notes to identify the issue, and a reference to a FAQ entry for the living list of known combinations. Then it's up to you to either document combinations you have seen work, or seen fail. Or maybe both... But I would keep it in a FAQ because it carries the authority of having been published, and not of just being a list that people can add to as they wish. You might also spawn a forum with a sticky topic for this issue.
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-