Proceedings are available on wikisym.org
and through the ACM digital library
WikiWiki Weaving Heterogeneous Software Artifacts
Ademar Aguiar, Gabriel DavidAbstract
Good documentation benefits every software development project, especially
large ones, but it can be hard, costly, and tiresome to produce when not
supported by appropriate tools and methods.
The documentation of a software system uses different artifacts, namely source
, for low-level internal documentation, and specific-purpose models
, for higher-level external documentation (e.g.
requirements documents, use-case specifications, design notebooks, and
reference manuals). All these artifacts require continual review and modification throughout the life-cycle to preserve their consistency and value.
Good software documents are often heterogeneous
, i.e., they combine different kinds of contents
code, models, images) gathered from separate software artifacts
combination usually difficult to maintain as the system evolves over time, considering that source code, models and documents are typically produced and maintained separately in multiple sources
using different environments and editors.
This paper presents a wiki that helps on quickly weaving
of contents into a single heterogeneous document, whilst preserving its
semantic consistency. The fundamental goal of this wiki (XSDoc Wiki) is to
reduce the development-documentation
gap by making documentation more
convenient and attractive to developers. An example taken from the JUnit
framework documentation helps to illustrate the features more relevant
to do such weaving.