cedrom-sni’s dita- based project from analysis to delivery by france baril documentation architect
TRANSCRIPT
![Page 1: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/1.jpg)
CEDROM-SNi’s DITA-based Project
From Analysis to Delivery
By
France BarilDocumentation Architect
![Page 2: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/2.jpg)
Overview of the project deliverables and content
![Page 3: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/3.jpg)
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.
![Page 4: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/4.jpg)
Online Help Delivery Process
![Page 5: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/5.jpg)
Highlights
•The production and delivery modes are useful to prevent users from waiting too long for topic display. Pre-processed elements include:o The table of contento The indexo 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
![Page 6: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/6.jpg)
Pre-processed Table of Content
![Page 7: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/7.jpg)
Pre-processed Index
![Page 8: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/8.jpg)
Pre-processed Related Links
![Page 9: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/9.jpg)
Search with Options and Results based on Topic Types
![Page 10: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/10.jpg)
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.
![Page 11: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/11.jpg)
Creating the Web Services Online Help
Extra step
![Page 12: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/12.jpg)
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.
![Page 13: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/13.jpg)
Web Services Methods
![Page 14: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/14.jpg)
Creating a PDF Training Manual
![Page 15: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/15.jpg)
Highlights
•Training sessions are almost always different because the needs vary:
o New users who want the product for media monitoringo New users who want to share news on their intraneto New “knowledge management” user who needs to learn
how to create advanced querieso Regular users who want to learn new functionalitieso Regular user who are going to use the tool for new
purposeso Computer literate users vs not-so-computer literate
users…
•Documents include the same kind of table of content and index as the online help.
![Page 16: CEDROM-SNi’s DITA- based Project From Analysis to Delivery By France Baril Documentation Architect](https://reader035.vdocuments.us/reader035/viewer/2022062407/56649dd25503460f94ac8c08/html5/thumbnails/16.jpg)
Elements of PDF Documents based on DITA maps