Technical Documentation

Software Description

A document outlining the functionalities of a task-driven documentation software (TimBox) for a business forum held in Tokyo (2011).

Software Documentation

Documentation of TimBox (pdf generated by the software, lacks of elegance!)

Cahiers des charges d’ouvrages complexes

La segmentation actuelle des cahiers des charges utilisés pour l’exécution et le contrôle des ouvrages dans le domaine du bâtiment est conçue par lots, alors que chaque type de composant de l’ouvrage (les portes, par exemple), est soumis aux contraintes relatives à des lots différents (les ventouses électro-magnétiques des portes apparaissant dans le lot “Courants faibles”, alors que les portes se trouvent décrites dans le lot “Menuiserie intérieure”).

Les spécifications à retenir par le prestataire responsable des portes (qui appartient à un corps de métier défini, “Menuisier”), sont disséminées dans la cahier des charges mais également complétées par les “bonnes pratiques” officielles, qui font légalement autorité (les DTU). Cette étude propose un système de navigation de l’ensemble des contraintes applicables, non pas par corps de métier (et, donc, de “lots”), mais par segment d’ouvrage placé sous la responsabilité du même prestataire.

Adapting Specifications to Recipients: Target Analysis

Complex systems usually involve several providers (of parts, of services). As the system is specified as a whole when the order is placed, different actors are bound to disentangle specifications so as to locate what precisely concerns their work.

As each of them has an implicit model of what he contributes to the overall system (some part, as actuators, or some work, as cabling or physically installing), specifications should be organised so as to fit these models. Indeed, most of non-quality cost ground in misunderstanding of specifications.

Software Specification Sheet

This is an example of a commercial presentation describing the capacities of a software engineered for technical documentation and process analysis.

A Section of a Printer Toy User-manual

The purpose of this excerpt is to illustrate how to design and use graphics in user-manuals, how to translate alternative tasks and option-lists into instructions (here, loading and outputting of paper) and how to use warning messages and tips within a task-oriented procedure. “Task-oriented procedures” are based on user goals instead of focusing on the structure of a device.

A Section of a Travel-agency Booking Manual

What makes this work description different from ordinary user-manuals is that each task is enhanced with an information cluster identifying the agent concerned and the estimated time of task-completion. This pattern (agent / duration) has been included in the task model and can therefore  be automatically inserted into the process description.