ClickHelp is a comprehensive online documentation and help authoring tool designed to streamline the process of creating, managing, and publishing technical documentation. Here’s an overview of what the product does and its key features:
What ClickHelp Does
ClickHelp is an all-in-one solution for technical writers, documentation teams, and organizations needing to create and manage user manuals, knowledge bases, software documentation, corporate wikis, FAQs, and other types of technical content. It enhances the efficiency and quality of the documentation process, from content creation to publication and maintenance.
Key Features
Content Creation and Editing
- Powerful Topic Editor: ClickHelp features a WYSIWYG (What You See Is What You Get) editor with Word-like functionality, allowing users to enrich their content with multimedia elements such as screenshots, charts, diagrams, images, and video tutorials. Additionally, it includes an HTML Source Editor for advanced users.
Collaboration and Workflow
- Co-authoring: Multiple authors can work collaboratively on the same document in real time, with designated roles for authors, reviewers, and translators. Custom workflow statuses and email notifications ensure that teams stay updated on task assignments and status changes.
Single-Sourcing and Content Reuse
- Single-Sourcing: This feature links similar documents to a common source, ensuring consistent terminology and definitions throughout the knowledge base. It includes content snippets, variables, conditional content blocks, and output tags to minimize the effort required for updating and maintaining documentation.
- Content Snippets: Allows for the dynamic insertion of content that can be updated globally, eliminating the need for repetitive updates across multiple documents.
Version Control and History
- Version Control: All versions of a topic can be viewed, compared, and restored. Users can see who made the changes and when, ensuring transparency and the ability to roll back changes if necessary.
Security and Compliance
- SSL Data Encryption: Ensures that all data is secure and encrypted, protecting sensitive information.
- Password Protection: User manuals can be protected with passwords to restrict access.
Customization and Branding
- Custom Landing Pages: Users can create and customize their documentation portals with their company’s style and logo, making the documentation recognizable and aligned with their brand.
- Responsive UI: The platform is fully responsive, allowing access to user documentation on various devices such as tablets and smartphones.
Publishing and Export
- Hosted Documentation Portal: ClickHelp can host the documentation portal for users, or users can host it themselves. The platform supports various export formats including CHM, PDF, Word, EPUB, RTF, ODT, and MHT.
- Printed Output Customization: Offers flexible options for customizing the output of printed user manuals.
Integrations and Analytics
- Integrations: ClickHelp integrates with a wide range of tools such as Zendesk, AddThis, Disqus, Google Analytics, Google Search Console, Azure AD SSO, Salesforce SSO, YouTube, Vimeo, and more.
- Advanced Analytics: Includes inbuilt analytics to help users analyze the performance of their documentation and plan future projects. The platform also supports Google Analytics integration.
Search and Feedback
- Patented Full-Text Search Engine: Features a powerful search engine with fuzzy search capabilities, making it easier for users to find relevant content even if they don’t remember the exact phrases.
- Topic Comments and Rating: Allows users to comment on topics and rate them, providing valuable feedback for improving the documentation.
Backup and Security
- Daily Backups: All data is backed up daily to ensure that user content is safe and can be recovered in case of any issues.
In summary, ClickHelp is a robust tool that simplifies the creation, management, and publication of technical documentation, offering a wide range of features that enhance collaboration, efficiency, and the overall quality of the documentation process.