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: The model becomes the software, the model becomes the docs?
Subject:Re: The model becomes the software, the model becomes the docs? From:"Bill Swallow" <techcommdood -at- gmail -dot- com> To:"Ned Bedinger" <doc -at- edwordsmith -dot- com> Date:Mon, 29 Oct 2007 15:39:35 -0400
> Anyway, as tech writer, I think I could work with 90% less SME time
> required if I had a self-documenting model to work from.
"Self-documenting" is a loaded term. It's only self-documenting if
it's been documented up front. Javadocs are about as useful as those
writing the code make them; if the info's not in there, sure you get a
reflection-spawned system of HTML files showing the basic info about
the code, but nothing real-world-useful. If properly documented up
front though, these can be powerful tools for users of the systems,
APIs, ASKs, and whatnot. But they are not self-documenting in an
artificial intelligence kind of way.
> Does anyone work with a dev team that thinks adding documentary
> explanations to the model components is a bridge for the tech writers?
I'm soaking in it.
--
Bill Swallow
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter
STC Single-Sourcing SIG Manager http://techcommdood.blogspot.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
