The model becomes the software, the model becomes the docs?

Subject: The model becomes the software, the model becomes the docs?
From: Ned Bedinger <doc -at- edwordsmith -dot- com>
To: Techwr-L List <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 29 Oct 2007 12:37:44 -0700

These guys seem to be making computers more intuitive:,1895,2100538,00.asp

So I wonder, if the model becomes the software, couldn't it become the
documentation too?

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.

Recall that UML was going to tie documentation to models, by having
everything in the model self-documenting--just query anything to see its
own explanation of what it does.

Self-documenting code (like javadocs) is supposed to do something
similar for the documentation of programming code, and techwr-l gets an
occasional comment confirming that this can work, so why not
self-documenting models?

Does anyone work with a dev team that thinks adding documentary
explanations to the model components is a bridge for the tech writers?

Ned Bedinger
doc -at- edwordsmith -dot- 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.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


Previous by Author: Re: Additions to Technical Communication Skills
Next by Author: Re: Usage: Keeping the number of digits consistent?
Previous by Thread: Re: A Push for Plain English
Next by Thread: Re: The model becomes the software, the model becomes the docs?

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

Sponsored Ads