Towards Live Documents for Software Engineering Documentation
Anke Weber,
University of Victoria, Canada
Contents
An ACRE Live Document is
- a static document with a state
- data-driven and interactive
- adapts automatically and intelligently
to its context
- is implemented on top of standard office
platforms
Live documents can be used to
- synchronize code and documentation automatically
(e.g., keep diagrams in line with the source code)
- produce multiple output versions from one
source consistently (e.g., for print, online and audio
use)
- address different audience needs (e.g.,
user manuals for novice and expert users)
- explore the system without leaving the
document
- support group collaboration
Towards a Live Manual
Keeping documentation up-to-date
- synchronize graph analysis and visualization
using Excel built-in statistical functions and charts
- synchronize visualization of statistical
data using Excel charts
Enhancing documentation capabilities of the Rigi reverse engineering
system
- different views on the graph data and statistics
in Excel within one workbook
- copy Excel views to PowerPoint for advanced
presentations features
Keeping source code and documentation in sync
- capture Rigi graphs and display in Excel,
PowerPoint and Visio
- edit Rigi graphs in Excel, PowerPoint and
Visio
Meeting reverse engineering
requirements with Excel, PowerPoint, and Visio
| RE
requirement |
Excel |
PowerPoint |
Visio |
| Visualize
program information artefacts and architecture |
Drawing
tools |
Custom
presentations and animation |
Templates
for diagrams, e.g. UML and Web sites |
| Statistical
data analysis and metrics |
Built-in
statistical functions and charts |
|
|
| Re-document
system |
Report
builder |
Custom
presentations and animation |
Synchronize
with data sources |
| Repository
based |
OBDC support
Excel sheets as data sources
|
|
|
| Collaboration
features |
Protect
and share workbook |
Track
changes and merge documents |
|
|
Meeting scheduling and sending
documents via email
|
| Robust |
Standard
functionalities to build upon; e.g. 'undo' |
| Data-driven
and net-centric |
Web services, Smart Tags, and Dashboards, Web
publishing
Integrate with databases (e.g., Access) and MS server environments
|
| Interoperability |
Active X/OLE support
Support for XML and SVG objects
|
| End-user
programmable and Office automation |
Macro recording, playing, and editing, Scripting
with VB script
(Com) Add-Ins with VBA, Dynamic Libraries with .Net
|
| Leverage
cognitive support |
Large
user base:
according to Microsoft more than 250,000,000 users for Office |
|
