SlideShare une entreprise Scribd logo
1  sur  21
Choosing RoboHelp as
your HAT
- Raghuram Pandurangan
Agenda
• Introduction
• Analysis
 Current Scenario
 Limitations with Existing HAT
 Comparison of Tools
 Points to Consider
• Solution
• RoboHelp 2015 Overview
• RoboHelp Tips
• What’s New in RoboHelp 2017
• CSH with Online Help
• Demo
Introduction
 Adobe RoboHelp
 WYSIWIG and good usability – flat learning curve
 Developed by eHelp and acquired by Macromedia in 2003,
later by Adobe in 2005 [version X5]
 How we chose RoboHelp
 Analysis
 Points to Consider
 Solution
eHelp
Macromedia
Adobe
Analysis
Current Scenario
• MS Word for authoring
• Drupal 4.x for Online Help [OLH]
• Limited resources and time
• Existing help content in MS Word
• Agile process – need to show progress
Limitations with Existing HAT
 Spend too much time in formatting and alignment of multi-level
headings
 MS Word prone to crash with bulky documents
 Drupal OLH is difficult to customize
 Content reuse and productivity is limited
 No versioning or conditional text
 No structured authoring
 Navigation and search in output is difficult
Consolidated Comparison of Tools
Tool
Price
UpgradeCost
OnlineHelp
Support
Versioning
Conditional
Easeof
Migration
MobileHelp
Structured
Authoring
Comments
Help and
Manual
$550 $389 for
Upgrade
  (with
Server
$1295)
    • Good WebHelp Output
• Minimum changes required after importing the RTF
document
• Supports Version when integrated Help & Manual
Server
• Has inbuilt screenshot enhancer(Impict)
Help Smith $199 $99 for
Upgrade
      • Supports variables, breadcrumbs, custom HTML
code.
• Supports Translation (Unicode support)
Helpinator $250 $250 for
Lifetime
Upgrade
      • Good retention of formatting when copy pasted
from MS Word
• Supports Translation
• Screenshot association with topics for easier
management of screenshots
Dr.Explain $249
OR
$349
No
Mention
      • Good Online Help output
• Easier organization of content
• Automate the Help Authoring (Needs Setup and
Learning required)
Tool
Price
Upgrade
Cost
OnlineHelp
Support
Versioning
Conditional
Text
Easeof
Migration
MobileHelp
Structured
Authoring
Comments
Adobe
RoboHelp
$999 $599   (with
Server-
$1999)
    • Flat Learning Curve
• Easily import from MS Word
• Easy customization of skins and
templates
• Good option for Online Help Output
Author-IT
(Client-Server)
$2000-
1000
(Group
of
Users)
No
Mention
      • Ease of Use
• Import from MS Word
• Easy Documentation Management and
Content reuse
PTC Arbor Text Secret
Pricing
Model
No
Mention
      • Automate the production with
integration of CMS
• Include interactive 2D and 3D
illustrations
• Easy to transfer MS Word content
(Copy/Paste)
Madcap Flare $1448 No
Mention
      • Steep Learning Curve
• Excellent output and customizations
available
• Consistent output and versatile
Adobe
FrameMaker
$999 $599 
(with
Plug-
in)
 (with
Server
$5999)
    • Steep Learning Curve
• Needs Plugin Software (needs to be
purchased) for Online Help
• Consistent output
• Good option for PDF output
Consolidated Comparison of Tools
[Contd.]
Points to Consider
• Reuse of existing MS Word content
• No training or limited time for learning the new HAT
• Content from new HAT must be delivered within next 6 months
• OLH support for multiple devices:
 Desktop
 Mobile
 Tabs
• Organization structure
• Content
• Easy to generate MS Word format files for reviews
• Easy to search content
• Easy to embed Videos
Why RoboHelp 2015?
• Import existing MS Word files easily
• Fit the company’s budget and user-based licensing
• Easy-to-use and less setup compared to leading HATs
• Use MS Word stylesheet itself
• Reuse content using topics and set up a
project once
• Indexing is easy and Search is customizable
RoboHelp 2015 Overview
 Easily import Word documents by mapping the
para tags
Single sourcing
RoboHelp 2015 Overview [Contd.]
 Output Setup and Output SSL tabs
 Master Pages (for MS Word output)
 Skins
 Screen Profiles
 Screen Layouts
RoboHelp 2015 Overview [Contd.]
 Index wizard to add index keywords topic-by-
topic
Generate batch of outputs on
single click
What’s New in RoboHelp 2017
• Dynamically filtered output
• Toggle the view between variable and its value
• Generate content centric to iOS and
Android – create apps
• Search suggestions and autocomplete
Tips for RoboHelp
 Create Base project
 Create a project with primary output
 Set up or import skin or screen layout
 Set up or import master pages
 Configure Output SSL for outputs used
 Copy the project to a shared location
 Copy the project for a new help project and rename the project file name
and properties
Tips for RoboHelp [Contd.]
 Understanding project files [XML format]
 .xpj –project information
 .hhc –TOC
 .hhk – Index
 .glo – glossary
 .fpj – each folder contains this file with index
Project
Topic2
Topic1
Useful when the project file (.xpj) is corrupted
Can be used to integrate topics where a team
is sharing project
CSH with Online Help
Author and Developer Roles for CSH
Creates map files
and assigns map
IDs to each Help.
Generates the
output to include
the context-
sensitive Help
topics.
Tests the context-
sensitive topics in
the application.
Writes code that
calls the correct
Help topics from
within the
application
Obtains map files
that contain the
map IDs from the
author.
Builds the
components that
make up the
application.
Notifies the author
when changes are
made to the
application.
AUTHOR DEVELOPER
Writes the Help
topics that describe
how to use
application.
Bibliography and References
• Adobe.com [A to Z of RoboHelp]
• Wiki (for eHelp)
• Graphics courtesy
• Adobe.com
• Combiboilerleeds.com
• www.aqusagtechnologies.com
• http://rpsec.usca.edu
• Further references
• RoboHelp 2015
• Content Strategy in Tech. Comm. –Sarah O’Keefe
• Technical Communication on Life Support: UX and Content Strategy are the
Reclamation! –Chris LaRoche
• The Intersection of Content Strategy and TechComm –Adobe Blog
• Bust a Move: From Tech. Comm. to Content Strategy –Madcap Webinar
• Content Strategy for Everything –Kristina Halvorson
 Contact Information
• Email: pragram@gmail.com
• LinkedIn: www.linkedin.com/in/raghuram77/
Thanks

Contenu connexe

Tendances

Introduction To Form Services In Mos22007 Csug
Introduction To Form Services In Mos22007   CsugIntroduction To Form Services In Mos22007   Csug
Introduction To Form Services In Mos22007 Csugdrudolph11
 
SharePoint 2013 Sandbox Solutions for On Premise or Office 365
SharePoint 2013 Sandbox Solutions for On Premise or Office 365SharePoint 2013 Sandbox Solutions for On Premise or Office 365
SharePoint 2013 Sandbox Solutions for On Premise or Office 365Ed Musters
 
User Interface Tips and Tricks for the Power User - Penelope Coventry
User Interface Tips and Tricks for the Power User - Penelope CoventryUser Interface Tips and Tricks for the Power User - Penelope Coventry
User Interface Tips and Tricks for the Power User - Penelope CoventrySPC Adriatics
 
SharePoint Framework, React, and Office UI sps Silicon Valley
SharePoint Framework, React, and Office UI sps Silicon ValleySharePoint Framework, React, and Office UI sps Silicon Valley
SharePoint Framework, React, and Office UI sps Silicon ValleySonja Madsen
 
Building SharePoint add-ins with JavaScript and c# sps Silicon Valley
Building SharePoint add-ins with JavaScript and c# sps Silicon ValleyBuilding SharePoint add-ins with JavaScript and c# sps Silicon Valley
Building SharePoint add-ins with JavaScript and c# sps Silicon ValleySonja Madsen
 
SharePoint Framework, React and Office UI SPS Paris 2016 - d01
SharePoint Framework, React and Office UI SPS Paris 2016 - d01SharePoint Framework, React and Office UI SPS Paris 2016 - d01
SharePoint Framework, React and Office UI SPS Paris 2016 - d01Sonja Madsen
 
Power up your Project Sites - SPS New Hampshire 2015
Power up your Project Sites - SPS New Hampshire 2015Power up your Project Sites - SPS New Hampshire 2015
Power up your Project Sites - SPS New Hampshire 2015bgerman
 
What's new for Developers in Visual Studio 2013
What's new for Developers in Visual Studio 2013What's new for Developers in Visual Studio 2013
What's new for Developers in Visual Studio 2013Microsoft Visual Studio
 
Custom Development in SharePoint – What are my options now?
Custom Development in SharePoint – What are my options now?Custom Development in SharePoint – What are my options now?
Custom Development in SharePoint – What are my options now?Talbott Crowell
 
LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables
LavaCon 2011: Double Trouble! Adding Developer Docs to Your DeliverablesLavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables
LavaCon 2011: Double Trouble! Adding Developer Docs to Your DeliverablesMary Connor
 
Introduction to SharePoint Framework (SPFx)
Introduction to SharePoint Framework (SPFx)Introduction to SharePoint Framework (SPFx)
Introduction to SharePoint Framework (SPFx)Fabio Franzini
 
Going with the Flow: Rationalizing the workflow options in SharePoint Online
Going with the Flow: Rationalizing the workflow options in SharePoint OnlineGoing with the Flow: Rationalizing the workflow options in SharePoint Online
Going with the Flow: Rationalizing the workflow options in SharePoint OnlineBob German
 
Workflow in SharePoint 2013
Workflow in SharePoint 2013Workflow in SharePoint 2013
Workflow in SharePoint 2013MJ Ferdous
 
Jump Start: Share Point Development
Jump Start: Share Point DevelopmentJump Start: Share Point Development
Jump Start: Share Point Developmentmattbremer
 
How to Build Dynamic Forms in Angular Directive with a Backend
How to Build Dynamic Forms in Angular Directive with a BackendHow to Build Dynamic Forms in Angular Directive with a Backend
How to Build Dynamic Forms in Angular Directive with a BackendBackand Cohen
 
Branding Modern SharePoint
Branding Modern SharePointBranding Modern SharePoint
Branding Modern SharePointEric Overfield
 
Branding Deployment in Office 365 and SharePoint 2013/2016
Branding Deployment in Office 365 and SharePoint 2013/2016Branding Deployment in Office 365 and SharePoint 2013/2016
Branding Deployment in Office 365 and SharePoint 2013/2016Stefan Bauer
 
Whats New In Share Point Designer 2010 Ayman El Hattab Cairo Code Camp
Whats New In Share Point Designer 2010    Ayman El Hattab   Cairo Code CampWhats New In Share Point Designer 2010    Ayman El Hattab   Cairo Code Camp
Whats New In Share Point Designer 2010 Ayman El Hattab Cairo Code CampAyman El-Hattab
 

Tendances (20)

Introduction To Form Services In Mos22007 Csug
Introduction To Form Services In Mos22007   CsugIntroduction To Form Services In Mos22007   Csug
Introduction To Form Services In Mos22007 Csug
 
SharePoint 2013 Sandbox Solutions for On Premise or Office 365
SharePoint 2013 Sandbox Solutions for On Premise or Office 365SharePoint 2013 Sandbox Solutions for On Premise or Office 365
SharePoint 2013 Sandbox Solutions for On Premise or Office 365
 
User Interface Tips and Tricks for the Power User - Penelope Coventry
User Interface Tips and Tricks for the Power User - Penelope CoventryUser Interface Tips and Tricks for the Power User - Penelope Coventry
User Interface Tips and Tricks for the Power User - Penelope Coventry
 
SharePoint Framework, React, and Office UI sps Silicon Valley
SharePoint Framework, React, and Office UI sps Silicon ValleySharePoint Framework, React, and Office UI sps Silicon Valley
SharePoint Framework, React, and Office UI sps Silicon Valley
 
Building SharePoint add-ins with JavaScript and c# sps Silicon Valley
Building SharePoint add-ins with JavaScript and c# sps Silicon ValleyBuilding SharePoint add-ins with JavaScript and c# sps Silicon Valley
Building SharePoint add-ins with JavaScript and c# sps Silicon Valley
 
SharePoint Framework, React and Office UI SPS Paris 2016 - d01
SharePoint Framework, React and Office UI SPS Paris 2016 - d01SharePoint Framework, React and Office UI SPS Paris 2016 - d01
SharePoint Framework, React and Office UI SPS Paris 2016 - d01
 
Power up your Project Sites - SPS New Hampshire 2015
Power up your Project Sites - SPS New Hampshire 2015Power up your Project Sites - SPS New Hampshire 2015
Power up your Project Sites - SPS New Hampshire 2015
 
All about SPFx
All about SPFxAll about SPFx
All about SPFx
 
What's new for Developers in Visual Studio 2013
What's new for Developers in Visual Studio 2013What's new for Developers in Visual Studio 2013
What's new for Developers in Visual Studio 2013
 
Custom Development in SharePoint – What are my options now?
Custom Development in SharePoint – What are my options now?Custom Development in SharePoint – What are my options now?
Custom Development in SharePoint – What are my options now?
 
LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables
LavaCon 2011: Double Trouble! Adding Developer Docs to Your DeliverablesLavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables
LavaCon 2011: Double Trouble! Adding Developer Docs to Your Deliverables
 
Introduction to SharePoint Framework (SPFx)
Introduction to SharePoint Framework (SPFx)Introduction to SharePoint Framework (SPFx)
Introduction to SharePoint Framework (SPFx)
 
Going with the Flow: Rationalizing the workflow options in SharePoint Online
Going with the Flow: Rationalizing the workflow options in SharePoint OnlineGoing with the Flow: Rationalizing the workflow options in SharePoint Online
Going with the Flow: Rationalizing the workflow options in SharePoint Online
 
Anatomy of a mail app
Anatomy of a mail appAnatomy of a mail app
Anatomy of a mail app
 
Workflow in SharePoint 2013
Workflow in SharePoint 2013Workflow in SharePoint 2013
Workflow in SharePoint 2013
 
Jump Start: Share Point Development
Jump Start: Share Point DevelopmentJump Start: Share Point Development
Jump Start: Share Point Development
 
How to Build Dynamic Forms in Angular Directive with a Backend
How to Build Dynamic Forms in Angular Directive with a BackendHow to Build Dynamic Forms in Angular Directive with a Backend
How to Build Dynamic Forms in Angular Directive with a Backend
 
Branding Modern SharePoint
Branding Modern SharePointBranding Modern SharePoint
Branding Modern SharePoint
 
Branding Deployment in Office 365 and SharePoint 2013/2016
Branding Deployment in Office 365 and SharePoint 2013/2016Branding Deployment in Office 365 and SharePoint 2013/2016
Branding Deployment in Office 365 and SharePoint 2013/2016
 
Whats New In Share Point Designer 2010 Ayman El Hattab Cairo Code Camp
Whats New In Share Point Designer 2010    Ayman El Hattab   Cairo Code CampWhats New In Share Point Designer 2010    Ayman El Hattab   Cairo Code Camp
Whats New In Share Point Designer 2010 Ayman El Hattab Cairo Code Camp
 

Similaire à Choosing Adobe RoboHelp as Your Help Authoring Tool

Rapid development of help files and user documentation in Dr.Explain 5
Rapid development of help files and user documentation in Dr.Explain 5Rapid development of help files and user documentation in Dr.Explain 5
Rapid development of help files and user documentation in Dr.Explain 5Dennis Zhuravlev (a.k.a. Crane)
 
SPS Monaco 2017 - The Lay of the Land of Client-Side Development circa 2017
SPS Monaco 2017 - The Lay of the Land of Client-Side Development circa 2017SPS Monaco 2017 - The Lay of the Land of Client-Side Development circa 2017
SPS Monaco 2017 - The Lay of the Land of Client-Side Development circa 2017Marc D Anderson
 
Bootstrapify Universal Theme
Bootstrapify Universal ThemeBootstrapify Universal Theme
Bootstrapify Universal ThemeChristian Rokitta
 
Latest trends in Technical Writing, Authoring on Cloud, Content Delivery for ...
Latest trends in Technical Writing, Authoring on Cloud, Content Delivery for ...Latest trends in Technical Writing, Authoring on Cloud, Content Delivery for ...
Latest trends in Technical Writing, Authoring on Cloud, Content Delivery for ...Raghuram Pandurangan
 
SharePoint 2013 Web Content Management for Developers TSPUG
SharePoint 2013 Web Content Management for Developers TSPUGSharePoint 2013 Web Content Management for Developers TSPUG
SharePoint 2013 Web Content Management for Developers TSPUGEd Musters
 
SharePoint 2013 Web Content Management for Developers HSPUG
SharePoint 2013 Web Content Management for Developers HSPUGSharePoint 2013 Web Content Management for Developers HSPUG
SharePoint 2013 Web Content Management for Developers HSPUGEd Musters
 
How to build a Project Hub with Hubsites and Sitedesign and Sitescripts
How to build a Project Hub with Hubsites and Sitedesign and Sitescripts How to build a Project Hub with Hubsites and Sitedesign and Sitescripts
How to build a Project Hub with Hubsites and Sitedesign and Sitescripts Knut Relbe-Moe [MVP, MCT]
 
Intro to the Office UI Fabric
Intro to the Office UI FabricIntro to the Office UI Fabric
Intro to the Office UI FabricThomas Daly
 
Presentation 1 Web--dev
Presentation 1 Web--devPresentation 1 Web--dev
Presentation 1 Web--devaltsav
 
Cross Site Collection Navigation using SPFx, Powershell PnP & PnP-JS
Cross Site Collection Navigation using SPFx, Powershell PnP & PnP-JSCross Site Collection Navigation using SPFx, Powershell PnP & PnP-JS
Cross Site Collection Navigation using SPFx, Powershell PnP & PnP-JSThomas Daly
 
O365Con19 - Customise the UI in Modern SharePoint Workspaces - Corinna Lins
O365Con19 - Customise the UI in Modern SharePoint Workspaces - Corinna LinsO365Con19 - Customise the UI in Modern SharePoint Workspaces - Corinna Lins
O365Con19 - Customise the UI in Modern SharePoint Workspaces - Corinna LinsNCCOMMS
 
Pat Farrell, Migrating Legacy Documentation to XML and DITA
Pat Farrell, Migrating Legacy Documentation to XML and DITAPat Farrell, Migrating Legacy Documentation to XML and DITA
Pat Farrell, Migrating Legacy Documentation to XML and DITAfarrelldoc
 
Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...
Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...
Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...Sarah Silveri, RSI Content Solutions
 
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...LavaConConference
 
Code the docs-yu liu
Code the docs-yu liuCode the docs-yu liu
Code the docs-yu liuStreamNative
 
Automating Complex High-Volume Technical Paper and Journal Article Page Compo...
Automating Complex High-Volume Technical Paper and Journal Article Page Compo...Automating Complex High-Volume Technical Paper and Journal Article Page Compo...
Automating Complex High-Volume Technical Paper and Journal Article Page Compo...dclsocialmedia
 
Cross Site Collection Navigation
Cross Site Collection NavigationCross Site Collection Navigation
Cross Site Collection NavigationThomas Daly
 
Context Sensitive Help_Remedy
Context Sensitive Help_RemedyContext Sensitive Help_Remedy
Context Sensitive Help_RemedyDebjani Sen
 

Similaire à Choosing Adobe RoboHelp as Your Help Authoring Tool (20)

Rapid development of help files and user documentation in Dr.Explain 5
Rapid development of help files and user documentation in Dr.Explain 5Rapid development of help files and user documentation in Dr.Explain 5
Rapid development of help files and user documentation in Dr.Explain 5
 
SPS Monaco 2017 - The Lay of the Land of Client-Side Development circa 2017
SPS Monaco 2017 - The Lay of the Land of Client-Side Development circa 2017SPS Monaco 2017 - The Lay of the Land of Client-Side Development circa 2017
SPS Monaco 2017 - The Lay of the Land of Client-Side Development circa 2017
 
Bootstrapify Universal Theme
Bootstrapify Universal ThemeBootstrapify Universal Theme
Bootstrapify Universal Theme
 
Latest trends in Technical Writing, Authoring on Cloud, Content Delivery for ...
Latest trends in Technical Writing, Authoring on Cloud, Content Delivery for ...Latest trends in Technical Writing, Authoring on Cloud, Content Delivery for ...
Latest trends in Technical Writing, Authoring on Cloud, Content Delivery for ...
 
SharePoint 2013 Web Content Management for Developers TSPUG
SharePoint 2013 Web Content Management for Developers TSPUGSharePoint 2013 Web Content Management for Developers TSPUG
SharePoint 2013 Web Content Management for Developers TSPUG
 
SharePoint 2013 Web Content Management for Developers HSPUG
SharePoint 2013 Web Content Management for Developers HSPUGSharePoint 2013 Web Content Management for Developers HSPUG
SharePoint 2013 Web Content Management for Developers HSPUG
 
How to build a Project Hub with Hubsites and Sitedesign and Sitescripts
How to build a Project Hub with Hubsites and Sitedesign and Sitescripts How to build a Project Hub with Hubsites and Sitedesign and Sitescripts
How to build a Project Hub with Hubsites and Sitedesign and Sitescripts
 
Intro to the Office UI Fabric
Intro to the Office UI FabricIntro to the Office UI Fabric
Intro to the Office UI Fabric
 
Presentation 1 Web--dev
Presentation 1 Web--devPresentation 1 Web--dev
Presentation 1 Web--dev
 
Html,CSS & UI/UX design
Html,CSS & UI/UX designHtml,CSS & UI/UX design
Html,CSS & UI/UX design
 
Cross Site Collection Navigation using SPFx, Powershell PnP & PnP-JS
Cross Site Collection Navigation using SPFx, Powershell PnP & PnP-JSCross Site Collection Navigation using SPFx, Powershell PnP & PnP-JS
Cross Site Collection Navigation using SPFx, Powershell PnP & PnP-JS
 
O365Con19 - Customise the UI in Modern SharePoint Workspaces - Corinna Lins
O365Con19 - Customise the UI in Modern SharePoint Workspaces - Corinna LinsO365Con19 - Customise the UI in Modern SharePoint Workspaces - Corinna Lins
O365Con19 - Customise the UI in Modern SharePoint Workspaces - Corinna Lins
 
Pat Farrell, Migrating Legacy Documentation to XML and DITA
Pat Farrell, Migrating Legacy Documentation to XML and DITAPat Farrell, Migrating Legacy Documentation to XML and DITA
Pat Farrell, Migrating Legacy Documentation to XML and DITA
 
SAP ByDesign Development
SAP ByDesign DevelopmentSAP ByDesign Development
SAP ByDesign Development
 
Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...
Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...
Don’t Hide Your Content in a Traditional Help System: A Case Study from TechP...
 
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
Planning our End Game at Automation Anywhere: A Story of Content and Tools St...
 
Code the docs-yu liu
Code the docs-yu liuCode the docs-yu liu
Code the docs-yu liu
 
Automating Complex High-Volume Technical Paper and Journal Article Page Compo...
Automating Complex High-Volume Technical Paper and Journal Article Page Compo...Automating Complex High-Volume Technical Paper and Journal Article Page Compo...
Automating Complex High-Volume Technical Paper and Journal Article Page Compo...
 
Cross Site Collection Navigation
Cross Site Collection NavigationCross Site Collection Navigation
Cross Site Collection Navigation
 
Context Sensitive Help_Remedy
Context Sensitive Help_RemedyContext Sensitive Help_Remedy
Context Sensitive Help_Remedy
 

Plus de Raghuram Pandurangan

Generative AI for Technical Writer or Information Developers
Generative AI for Technical Writer or Information DevelopersGenerative AI for Technical Writer or Information Developers
Generative AI for Technical Writer or Information DevelopersRaghuram Pandurangan
 
Integrating ChatGPT Bot to your Doc. Site in 45 minutes​
Integrating ChatGPT Bot to your Doc. Site in 45 minutes​Integrating ChatGPT Bot to your Doc. Site in 45 minutes​
Integrating ChatGPT Bot to your Doc. Site in 45 minutes​Raghuram Pandurangan
 
Software Technical Writing Industry
Software Technical Writing IndustrySoftware Technical Writing Industry
Software Technical Writing IndustryRaghuram Pandurangan
 
Enabling Communication for Documentation Teams
Enabling Communication for Documentation TeamsEnabling Communication for Documentation Teams
Enabling Communication for Documentation TeamsRaghuram Pandurangan
 
Why Help Authoring Tools are Important
Why Help Authoring Tools are ImportantWhy Help Authoring Tools are Important
Why Help Authoring Tools are ImportantRaghuram Pandurangan
 
Picture Archival and Communication System [PACS] - Overview
Picture Archival and Communication System [PACS] - OverviewPicture Archival and Communication System [PACS] - Overview
Picture Archival and Communication System [PACS] - OverviewRaghuram Pandurangan
 
Flow of Content in Help Documentation
Flow of Content in Help DocumentationFlow of Content in Help Documentation
Flow of Content in Help DocumentationRaghuram Pandurangan
 
Importing MS Word Documents in AuthorIT
Importing MS Word Documents in AuthorITImporting MS Word Documents in AuthorIT
Importing MS Word Documents in AuthorITRaghuram Pandurangan
 
Learnings from 14th STC India Conference
Learnings from 14th STC India ConferenceLearnings from 14th STC India Conference
Learnings from 14th STC India ConferenceRaghuram Pandurangan
 

Plus de Raghuram Pandurangan (16)

Generative AI for Technical Writer or Information Developers
Generative AI for Technical Writer or Information DevelopersGenerative AI for Technical Writer or Information Developers
Generative AI for Technical Writer or Information Developers
 
Integrating ChatGPT Bot to your Doc. Site in 45 minutes​
Integrating ChatGPT Bot to your Doc. Site in 45 minutes​Integrating ChatGPT Bot to your Doc. Site in 45 minutes​
Integrating ChatGPT Bot to your Doc. Site in 45 minutes​
 
Agile Scrum for Technical Writers
Agile Scrum for Technical WritersAgile Scrum for Technical Writers
Agile Scrum for Technical Writers
 
ChatGPT for Technical Writers
ChatGPT for Technical WritersChatGPT for Technical Writers
ChatGPT for Technical Writers
 
API Documentation Tool Comparison
API Documentation Tool ComparisonAPI Documentation Tool Comparison
API Documentation Tool Comparison
 
Software Technical Writing Industry
Software Technical Writing IndustrySoftware Technical Writing Industry
Software Technical Writing Industry
 
Enabling Communication for Documentation Teams
Enabling Communication for Documentation TeamsEnabling Communication for Documentation Teams
Enabling Communication for Documentation Teams
 
Why Help Authoring Tools are Important
Why Help Authoring Tools are ImportantWhy Help Authoring Tools are Important
Why Help Authoring Tools are Important
 
Content Conversion Best Practices
Content Conversion Best PracticesContent Conversion Best Practices
Content Conversion Best Practices
 
Picture Archival and Communication System [PACS] - Overview
Picture Archival and Communication System [PACS] - OverviewPicture Archival and Communication System [PACS] - Overview
Picture Archival and Communication System [PACS] - Overview
 
Hl7 Overview
Hl7 OverviewHl7 Overview
Hl7 Overview
 
Flow of Content in Help Documentation
Flow of Content in Help DocumentationFlow of Content in Help Documentation
Flow of Content in Help Documentation
 
Importing MS Word Documents in AuthorIT
Importing MS Word Documents in AuthorITImporting MS Word Documents in AuthorIT
Importing MS Word Documents in AuthorIT
 
Learnings from 14th STC India Conference
Learnings from 14th STC India ConferenceLearnings from 14th STC India Conference
Learnings from 14th STC India Conference
 
Effective googling
Effective googlingEffective googling
Effective googling
 
RoboHelp 2002 - overview
RoboHelp 2002 - overviewRoboHelp 2002 - overview
RoboHelp 2002 - overview
 

Dernier

Streamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupStreamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupFlorian Wilhelm
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii SoldatenkoFwdays
 
From Family Reminiscence to Scholarly Archive .
From Family Reminiscence to Scholarly Archive .From Family Reminiscence to Scholarly Archive .
From Family Reminiscence to Scholarly Archive .Alan Dix
 
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)Mark Simos
 
DevEX - reference for building teams, processes, and platforms
DevEX - reference for building teams, processes, and platformsDevEX - reference for building teams, processes, and platforms
DevEX - reference for building teams, processes, and platformsSergiu Bodiu
 
Search Engine Optimization SEO PDF for 2024.pdf
Search Engine Optimization SEO PDF for 2024.pdfSearch Engine Optimization SEO PDF for 2024.pdf
Search Engine Optimization SEO PDF for 2024.pdfRankYa
 
Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 365Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 3652toLead Limited
 
DSPy a system for AI to Write Prompts and Do Fine Tuning
DSPy a system for AI to Write Prompts and Do Fine TuningDSPy a system for AI to Write Prompts and Do Fine Tuning
DSPy a system for AI to Write Prompts and Do Fine TuningLars Bell
 
Developer Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLDeveloper Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLScyllaDB
 
"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr Bagan"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr BaganFwdays
 
What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024Stephanie Beckett
 
Unleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding ClubUnleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding ClubKalema Edgar
 
Anypoint Exchange: It’s Not Just a Repo!
Anypoint Exchange: It’s Not Just a Repo!Anypoint Exchange: It’s Not Just a Repo!
Anypoint Exchange: It’s Not Just a Repo!Manik S Magar
 
TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024Lonnie McRorey
 
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptx
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptxMerck Moving Beyond Passwords: FIDO Paris Seminar.pptx
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptxLoriGlavin3
 
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024BookNet Canada
 
Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?Mattias Andersson
 
Powerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time ClashPowerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time Clashcharlottematthew16
 
Commit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easyCommit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easyAlfredo García Lavilla
 
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage CostLeverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage CostZilliz
 

Dernier (20)

Streamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupStreamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project Setup
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko
 
From Family Reminiscence to Scholarly Archive .
From Family Reminiscence to Scholarly Archive .From Family Reminiscence to Scholarly Archive .
From Family Reminiscence to Scholarly Archive .
 
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
 
DevEX - reference for building teams, processes, and platforms
DevEX - reference for building teams, processes, and platformsDevEX - reference for building teams, processes, and platforms
DevEX - reference for building teams, processes, and platforms
 
Search Engine Optimization SEO PDF for 2024.pdf
Search Engine Optimization SEO PDF for 2024.pdfSearch Engine Optimization SEO PDF for 2024.pdf
Search Engine Optimization SEO PDF for 2024.pdf
 
Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 365Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 365
 
DSPy a system for AI to Write Prompts and Do Fine Tuning
DSPy a system for AI to Write Prompts and Do Fine TuningDSPy a system for AI to Write Prompts and Do Fine Tuning
DSPy a system for AI to Write Prompts and Do Fine Tuning
 
Developer Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLDeveloper Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQL
 
"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr Bagan"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr Bagan
 
What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024
 
Unleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding ClubUnleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding Club
 
Anypoint Exchange: It’s Not Just a Repo!
Anypoint Exchange: It’s Not Just a Repo!Anypoint Exchange: It’s Not Just a Repo!
Anypoint Exchange: It’s Not Just a Repo!
 
TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024
 
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptx
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptxMerck Moving Beyond Passwords: FIDO Paris Seminar.pptx
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptx
 
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
 
Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?
 
Powerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time ClashPowerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time Clash
 
Commit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easyCommit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easy
 
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage CostLeverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
 

Choosing Adobe RoboHelp as Your Help Authoring Tool

  • 1. Choosing RoboHelp as your HAT - Raghuram Pandurangan
  • 2. Agenda • Introduction • Analysis  Current Scenario  Limitations with Existing HAT  Comparison of Tools  Points to Consider • Solution • RoboHelp 2015 Overview • RoboHelp Tips • What’s New in RoboHelp 2017 • CSH with Online Help • Demo
  • 3. Introduction  Adobe RoboHelp  WYSIWIG and good usability – flat learning curve  Developed by eHelp and acquired by Macromedia in 2003, later by Adobe in 2005 [version X5]  How we chose RoboHelp  Analysis  Points to Consider  Solution eHelp Macromedia Adobe
  • 5. Current Scenario • MS Word for authoring • Drupal 4.x for Online Help [OLH] • Limited resources and time • Existing help content in MS Word • Agile process – need to show progress
  • 6. Limitations with Existing HAT  Spend too much time in formatting and alignment of multi-level headings  MS Word prone to crash with bulky documents  Drupal OLH is difficult to customize  Content reuse and productivity is limited  No versioning or conditional text  No structured authoring  Navigation and search in output is difficult
  • 7. Consolidated Comparison of Tools Tool Price UpgradeCost OnlineHelp Support Versioning Conditional Easeof Migration MobileHelp Structured Authoring Comments Help and Manual $550 $389 for Upgrade   (with Server $1295)     • Good WebHelp Output • Minimum changes required after importing the RTF document • Supports Version when integrated Help & Manual Server • Has inbuilt screenshot enhancer(Impict) Help Smith $199 $99 for Upgrade       • Supports variables, breadcrumbs, custom HTML code. • Supports Translation (Unicode support) Helpinator $250 $250 for Lifetime Upgrade       • Good retention of formatting when copy pasted from MS Word • Supports Translation • Screenshot association with topics for easier management of screenshots Dr.Explain $249 OR $349 No Mention       • Good Online Help output • Easier organization of content • Automate the Help Authoring (Needs Setup and Learning required)
  • 8. Tool Price Upgrade Cost OnlineHelp Support Versioning Conditional Text Easeof Migration MobileHelp Structured Authoring Comments Adobe RoboHelp $999 $599   (with Server- $1999)     • Flat Learning Curve • Easily import from MS Word • Easy customization of skins and templates • Good option for Online Help Output Author-IT (Client-Server) $2000- 1000 (Group of Users) No Mention       • Ease of Use • Import from MS Word • Easy Documentation Management and Content reuse PTC Arbor Text Secret Pricing Model No Mention       • Automate the production with integration of CMS • Include interactive 2D and 3D illustrations • Easy to transfer MS Word content (Copy/Paste) Madcap Flare $1448 No Mention       • Steep Learning Curve • Excellent output and customizations available • Consistent output and versatile Adobe FrameMaker $999 $599  (with Plug- in)  (with Server $5999)     • Steep Learning Curve • Needs Plugin Software (needs to be purchased) for Online Help • Consistent output • Good option for PDF output Consolidated Comparison of Tools [Contd.]
  • 9. Points to Consider • Reuse of existing MS Word content • No training or limited time for learning the new HAT • Content from new HAT must be delivered within next 6 months • OLH support for multiple devices:  Desktop  Mobile  Tabs • Organization structure • Content • Easy to generate MS Word format files for reviews • Easy to search content • Easy to embed Videos
  • 10.
  • 11. Why RoboHelp 2015? • Import existing MS Word files easily • Fit the company’s budget and user-based licensing • Easy-to-use and less setup compared to leading HATs • Use MS Word stylesheet itself • Reuse content using topics and set up a project once • Indexing is easy and Search is customizable
  • 12. RoboHelp 2015 Overview  Easily import Word documents by mapping the para tags Single sourcing
  • 13. RoboHelp 2015 Overview [Contd.]  Output Setup and Output SSL tabs  Master Pages (for MS Word output)  Skins  Screen Profiles  Screen Layouts
  • 14. RoboHelp 2015 Overview [Contd.]  Index wizard to add index keywords topic-by- topic Generate batch of outputs on single click
  • 15. What’s New in RoboHelp 2017 • Dynamically filtered output • Toggle the view between variable and its value • Generate content centric to iOS and Android – create apps • Search suggestions and autocomplete
  • 16. Tips for RoboHelp  Create Base project  Create a project with primary output  Set up or import skin or screen layout  Set up or import master pages  Configure Output SSL for outputs used  Copy the project to a shared location  Copy the project for a new help project and rename the project file name and properties
  • 17. Tips for RoboHelp [Contd.]  Understanding project files [XML format]  .xpj –project information  .hhc –TOC  .hhk – Index  .glo – glossary  .fpj – each folder contains this file with index Project Topic2 Topic1 Useful when the project file (.xpj) is corrupted Can be used to integrate topics where a team is sharing project
  • 19. Author and Developer Roles for CSH Creates map files and assigns map IDs to each Help. Generates the output to include the context- sensitive Help topics. Tests the context- sensitive topics in the application. Writes code that calls the correct Help topics from within the application Obtains map files that contain the map IDs from the author. Builds the components that make up the application. Notifies the author when changes are made to the application. AUTHOR DEVELOPER Writes the Help topics that describe how to use application.
  • 20. Bibliography and References • Adobe.com [A to Z of RoboHelp] • Wiki (for eHelp) • Graphics courtesy • Adobe.com • Combiboilerleeds.com • www.aqusagtechnologies.com • http://rpsec.usca.edu • Further references • RoboHelp 2015 • Content Strategy in Tech. Comm. –Sarah O’Keefe • Technical Communication on Life Support: UX and Content Strategy are the Reclamation! –Chris LaRoche • The Intersection of Content Strategy and TechComm –Adobe Blog • Bust a Move: From Tech. Comm. to Content Strategy –Madcap Webinar • Content Strategy for Everything –Kristina Halvorson
  • 21.  Contact Information • Email: pragram@gmail.com • LinkedIn: www.linkedin.com/in/raghuram77/ Thanks

Notes de l'éditeur

  1. See eHelp wiki.
  2. Before importing the Word documents, cleanup the document to remove Cover page, Header/Footer, Figure/Caption number, Heading numbering, etc. Take a note of the most used para tags in MS Word and then start importing process to map the source formatting with RoboHelp tags.
  3. For indexing and batch generate, see Adobe.com.
  4. The .hhc (TOC) and .xpj (Project) file can be used to integrate topics when a project is shared across several technical writers. A Versioning system or repository can be used to check-in the project, so whenever a writer includes a new topic, he can include the topic in the TOC and the project and check-in. When other writers check-out from the Version system to get the updated project.
  5. In case of Online Help or CHM bundled with product builds, you can implement CSH either using RoboHelp CSH mapper or go for out-of-the-box CSH. The flowchart provides the roles of author (technical writer) and developer when implementing CSH in your product. The config file is in JSON format (similar to XML format). The author must ensure that every screen or GUI in the product has a tag and corresponding help location (relative location from product installation home folder).The developer must create a function or class to open the help topic in the default browser based on the tag passed to the function or class. When a developer implements a screen or GUI, the developer must add the Help button or F1 hotkey to use the function or class to pass the tag for the respective screen or GUI.