Software documentation


A research project for software documentation and training

The SoftDoc project originated from the realization that creating and maintaining the necessary material for learning an application is a wager for editors or users of complex software: training slideshows, user guides, exercise solution books, student supports, guided tours, upgrade guides, tutorials, online help and so on.

The idea

Pooling content between different types of document,
Creating different scenarios belonging to each context of use,
Publishing in different formats.

Results

Three publishing chains being tried out:

Guide: Creating a guide to get started with an application.
SoftDoc Formation: Creating pedagogical content used in face to face training.
SoftDoc: A single chain bringing together Guide, SoftDoc Formation and the reference documentation.