CEDROM-SNi’s DITA based Project

From Analysis to Delivery By France Baril Documentation Architect

Overview of the project deliverables and content

Highlights • Opportunity for reuse at the functionality and tasks levels.

* Functionalities are presented as concepts Training guides vary from one training class to the next: there is a great need for a flexible topic organisation.

• Multiple user types with different access to functionalities, need for conditional text based on audience.

Online Help Delivery Process

Highlights • The production and delivery modes are useful to prevent users from waiting too long for topic display. Pre-processed elements include: o o The table of content The index o The related links • There is also a need to save only the relevant files in the document base, so that other files are not returned by the search engine. Its faster than checking the map every time for project relevance

Pre-processed Table of Content

Pre-processed Index

Pre-processed Related Links

Search with Options and Results based on Topic Types

Highlights • Titles and the content are indexed separately in TEXTML Server to offer more precise search capabilities to users.

• Synonymous are included in the prolog/keyword element. So when a users do not know the exact expression used in the text, they can find related information. • Results are separated into descriptions (concepts, topics, references) and tasks.

Extra step Creating the Web Services Online Help

Highlights • Documentation for Web services operations is a mixed of WSDL information and code comments. The information is merged together. Each service and each methods becomes a DITA reference topic.

• A “submap” for all Web Services is created and referenced by the global project map.

Web Services Methods

Creating a PDF Training Manual

Highlights • Training sessions are almost always different because the needs vary: o New users who want the product for media monitoring o o o o o New users who want to share news on their intranet New “knowledge management” user who needs to learn how to create advanced queries Regular users who want to learn new functionalities Regular user who are going to use the tool for new purposes Computer literate users vs not-so-computer literate users… • Documents include the same kind of table of content and index as the online help.

Elements of PDF Documents based on DITA maps