Online documentation tool

13
Modern online documentation tool

Transcript of Online documentation tool

Page 1: Online documentation tool

Modern online documentation tool

Page 2: Online documentation tool

Modern Documentation ToolClickHelp makes it easy to work on your documentation projects from anywhere.

It’s a secure online portal for your employees!

● Cloud solution - easy to start● Browser-based - work from anywhere● Cross platform - MacOS, Windows, Linux● Secure - SSL-protected user authentication

Great combination of usage simplicity and powerful functions for advanced users.

Page 3: Online documentation tool

ClickHelp Offers SolutionsClickHelp is not just a set of great features,it offers solutions to documentation challenges.

With ClickHelp, you can accomplish a lot:

● Online user manuals, KBs and FAQs● Context help for your web applications● Printed downloadable content for clients● API documentation for your web services● Internal procedures and guides for employees

Single tool for many documentation needs!

Page 4: Online documentation tool

Your Authentic StyleWhen your clients navigate to the documentation, they need to feel that it’s still your resource.

We host your documentation portal, but you define how it looks and feels like:

● Assign your own domain name● Implement your custom Home page● Customize the UI colors● Create your unique documentation style

Perception is important, make your online documentation really beautiful!

Page 5: Online documentation tool

Reuse Your ContentThere is a moment in a documentation project, when you realize that the same chunk of content is used in multiple places.

This indicates the project maturity, and this is a great time to add some structure to your content to ease the maintenance, and improve productivity.

With ClickHelp, you can use Content Snippets and Variables to put the same content in many places, but update it everywhere at once.

Page 6: Online documentation tool

Work as a TeamWhen it comes to creating the documentation, many people get involved - technical writers, developers, translators, IT administrators.

And they have the same goal - produce great and useful content to help the clients.

ClickHelp has a lot to offer for Teams:

● Unlimited editing history● Automatic document locking● User roles to control permissions● Topic review notes for internal comments● Document statuses and workflow notifications

Page 7: Online documentation tool

Protect User ManualsWith ClickHelp, you have full control over your content - you decide who can access what.

It makes it easy to create public content that your clients will easily find in Google or Bing.

And it’s simple to create protected documents that require user login before they can read:

● Project guidelines● Employee instructions● Online manuals for partners● Internal company procedures● Protected documentation for clients

Page 8: Online documentation tool

Context-Sensitive Help"Context is worth 80 IQ points." Alan Key

Start helping your clients before they ask - add context help to your web application.

● Popups with useful tips and tricks● Links to a specific place in a topic● Assistant panels with rich content● Multi-step tutorials with navigation

Improve user experience, get higher conversion rates, reduce support load.

Page 9: Online documentation tool

Convenient EditorCreate beautiful content with the state-of-the-art wysiwyg editor.

● Headings, lists, screenshots● YouTube, Vimeo, Screencast● Interactive expandable blocks● Topic, file, and web page links● Automatic Breadcrumbs● Ready box elements for

Information and Warnings

Unlimited history of every topic is stored automatically, you can always revert your changes.

Page 10: Online documentation tool

Power of HTML SourceThe visual topic editing is certainly very nice. But ClickHelp does not limit you there!

You have full control over the content thanks to the HTML Source mode. Integrate any third-party JavaScript libraries into your content to accomplish your goals:

● Lightbox popups● Screenshot galleries● Online chat solutions● Interactive JavaScript elements● Code highlighting for developer documentation

Page 11: Online documentation tool

Multiple Output FormatsClickHelp is an online solution, but it can also generate downloadable content in different formats.

Just check the list of the main output formats:

● Documentation portal - we host the content● HTML5 Web Help - host on your server● CHM - Compiled HTML Help● PDF - Portable Document Format● DOCX - OpenXML, Microsoft Word 2007● DOC - Microsoft Word 97-2003● EPUB - electronic book● ODT - OpenDocument

Page 12: Online documentation tool

Single Sign-OnIntegrate your ClickHelp documentation portal into the existing authentication infrastructure with SSO.

ClickHelp offers complete support for theOpenID Connect authentication layer:

● Azure AD● Google● Salesforce● Custom OpenID Connect provider

Authenticate your Authors or Readers easily!

Page 13: Online documentation tool

Ready to get started?To check how ClickHelp works for you,

try ClickHelp for free

Contact us to learn more: [email protected]