Can an AI bot write technical documents?
Laura Lemay
lemay at lauralemay.com
Tue Aug 14 11:02:58 MDT 2007
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.
http://www.roland-weigelt.de/ghostdoc/
Laura
HelloWorld(): Helloes the world
--
*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^
Laura Lemay Killer of Trees lemay % lne.com lemay % gmail.com
http://www.lauralemay.com http://blog.lauralemay.com
*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^
More information about the TECHWR-L
mailing list