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.
Writing docs based on specifications is a good way to get out of sync
with the product, but use cases as I know them are nothing like specs.
They're short descriptions of what customers would do with specific
features of the product.
On Wed, Feb 4, 2015 at 6:26 PM, Keith Hood <klhra -at- yahoo -dot- com> wrote:
> The idea of basing documentation on use cases makes me nervous. It tells me the development team wants the docs written with only the use cases for source material. But there are ALWAYS gaps, bugs, shortfalls, and just plain mistakes between developing the use cases and cutting the gold master. There will be changes to the design that the technical writer will never know about until he sees the product itself, because the developers will all be too busy hunting bugs, or (happens all too often) they don't consider the tech writer really part of the team and they forgot he's there. Basing product documentation on any kind of design paper instead of basing it on looking at the actual product itself is nothing but a guarantee of documentation that is incomplete and out of phase with reality.There has never been an end-result product that actually works the way the design documents say it should, and I'll bet my entire next month's pay there never will be.
Doc-To-Help: The Quickest Way to Author and Publish Online Help, Policy & Procedure Guides, eBooks, and more using Microsoft Word | http://bit.ly/doctohelp2015