The best production documentation platform!
Use Cases and Deployment Scope
I use ClickHelp with our technical documentation team to host and manage our company product documentation. I create, update, and manage user manuals, tutorial videos, and API references for our company's end users.
The publishing process was one main challenge with hosting our product documentation. The platform we used then was just a document-sharing platform that did not support a publishing flow. ClickHelp provides a seamless and intuitive functionality for publishing documentation.
Another issue ClickHelp solved was maintaining versions of our product documentation. ClickHelp allows us to maintain multiple projects in one view, and multiple versions of the same project with rollback functionality.
Our documentation process has greatly improved since we started using ClickHelp.
Pros
- Seamless publishing process for documentation.
- Easy to use WYSIWYG editor for creating content.
- Easy customization of HTML and CSS elements.
Cons
- The See Also element should be able to automatically update when a new topic is added. Currently, we have to manually remove and re-add the element to do that.
- Ability to host image files externally (eg. S3, Dropbox), like it is done for videos. This will help save storage.
- Image files from imported projects are always duplicated, perhaps a bug, but it needs to be looked into.
Most Important Features
- Managing multiple projects.
- Support for partial and full publishing of documents.
- Support for hosting video content externally.
- Separate dashboards for reviewers, authors, and translators.
- Easy to use content editor
- Ability to customize styling of the platform.
Return on Investment
- We are able to cater to all our end-users regardless of the software version they are using, simply because we are able to provide multiple product documentation versions.
- Our documentation publishing time was reduced significantly due to the smooth process on ClickHelp.
- With one platform where all our product documentation can be housed, we are expanding technical documentation to other products.
Alternatives Considered
ClickUp and ProProfs Knowledge Base
Other Software Used
ClickUp, Amazon S3 (Simple Storage Service), Webex Calling
