Automatic documentation generation: Including examples

Cécile L. Paris*

*Corresponding author for this work

Research output: Chapter in Book/Report/Conference proceedingConference proceeding contributionpeer-review

Abstract

Good documentation is critical for user acceptance of any system, and empirical studies have shown that examples can greatly increase effectiveness of system documentation. However, studies also show that badly integrated text and examples can be actually detrimental compared to using either text or examples alone. It is thus clear that in order to provide useful documentation automatically, a system must be capable of providing well-integrated examples to illustrate its points. Previous work on example generation has concentrated on the issue of retrieving or constructing examples. In our work, we looked at the integration of text and examples. We identified how text and examples co-constrain each other and showed that a system must consider example generation as an integral part of the generation process. We implemented a system capable of producing documentation that integrated text and examples.

Original languageEnglish
Title of host publicationAdvances in Artificial Intelligence - 12th Brazilian Symposium on Artificial Intelligence, SBIA 1995, Proceedings
PublisherSpringer, Springer Nature
Pages12-25
Number of pages14
Volume991
ISBN (Print)3540604367, 9783540604365
DOIs
Publication statusPublished - 1995
Event12th Brazilian Symposium on Artificial Intelligence, SBIA 1995 - Campinas, Brazil
Duration: 10 Oct 199512 Oct 1995

Publication series

NameLecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics)
Volume991
ISSN (Print)03029743
ISSN (Electronic)16113349

Other

Other12th Brazilian Symposium on Artificial Intelligence, SBIA 1995
CountryBrazil
CityCampinas
Period10/10/9512/10/95

Fingerprint Dive into the research topics of 'Automatic documentation generation: Including examples'. Together they form a unique fingerprint.

Cite this