Re: RE : Can an AI bot write technical documents?

Subject: Re: RE : Can an AI bot write technical documents?
From: Laura Lemay <lemay -at- lauralemay -dot- com>
To: Lauren <lt34 -at- csus -dot- edu>
Date: Tue, 14 Aug 2007 10:02:58 -0700

Lauren wrote :
> So now I wonder, if an AI bot could perform basic technical writing tasks.
> Like if information from a work flow was given to a bot, can the bot piece
> the information together in a reasonably intelligent way so that the work
> would really only require editing by a person? At least for some pieces of
> the documentation anyway.

In the project I'm working on right now the engineers use a tool called
GhostDoc to insert API documentation comments in C# code from inside
VisualStudio. GhostDoc uses the method and parameter names to generate
passable english doc comments.

The GhostDoc tool, of course, relies on decent method and parameter
naming conventions in the first place. And the documentation it
generates is by no means complete; all of it is of the "SetColor: sets
the color" grade of usefulness, eg, not all that useful. But I've
known plenty of API tech writers who wrote docs to that level of
quality, and as a first pass on a project with not a lot of writer
resources, its surprisingly good.

The bots are already here.

HelloWorld(): Helloes the world

Laura Lemay Killer of Trees lemay % lemay %


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.

RE : Can an AI bot write technical documents?: From: Yves JEAUROND

Previous by Author: Re: Recent User Assistance Studies on Printed Books?
Next by Author: Re: Guess what: we suck!
Previous by Thread: RE: RE : Can an AI bot write technical documents?
Next by Thread: Re: RE : Can an AI bot write technical documents?

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

Sponsored Ads