Advices, suggestions and ideas on developing and improving help and manual writing and production.

The Future of Documentation: How Help Authoring Tools are Empowering Technical Writers and Organizations

The Future of Documentation: How Help Authoring Tools are Empowering Technical Writers and Organizations
Categories: articles

The documentation landscape is constantly evolving, and HelpNDoc has emerged as a leading help authoring tool that’s changing the way we create, maintain, and share information. With its ability to streamline the documentation process, improve content quality, and integrate with advanced technologies, HelpNDoc is redefining the industry’s future. Let’s explore how HelpNDoc is shaping the future of documentation. The Shift to User-Centric Content HelpNDoc enables a user-centric approach to documentation, prioritizing the needs and preferences of the end-user.

Read More →

Bridging the Gap Between Teachers and Students: Harnessing the Power of Help-Authoring Tools for Engaging Content Creation

Bridging the Gap Between Teachers and Students: Harnessing the Power of Help-Authoring Tools for Engaging Content Creation
Categories: articles

In today’s fast-paced world, educators are constantly seeking innovative ways to provide a comprehensive and engaging learning experience for their students. One such tool that has emerged as a game-changer in this pursuit is HelpNDoc. This help-authoring tool has the potential to revolutionize the way teachers impart knowledge and assist their students. In this article, we will delve into the reasons why HelpNDoc should be the go-to choice for teachers to create educational content and support their students effectively.

Read More →

How technical writers can include PHP code in their online documentation

How technical writers can include PHP code in their online documentation
Categories: articles

PHP is a powerful server-side scripting language that has been an essential tool for web development for decades. With its ability to dynamically generate content, enhance user experience, handle security restrictions, increase interactivity or collect user data, it is a great addition to online user documentation. Thanks to the HelpNDoc help authoring tool’s powerful and versatile template system, these benefits are now easily achievable: let’s explore how incorporating PHP into online user documentation can help to improve the user experience and provide better engagement and feedback.

Read More →

How to create a CHM help file: use a modern help authoring software instead of the outdated HTML Help Workshop

How to create a CHM help file: use a modern help authoring software instead of the outdated HTML Help Workshop
Categories: articles

CHM help files are used to provide online help and documentation for software applications, plugins or drivers, and are commonly distributed with Windows installers. Third-party programs like HelpNDoc are specialized help authoring software tools that can make it easier and faster to create a CHM help file. Using a third-party program to create a CHM help file can provide several benefits compared to using the built-in HTML Help Workshop program provided by Microsoft, as they offer a user-friendly graphical interface, powerful features, time-saving tools, and flexibility that can make it easier and more efficient to create a professional-looking CHM help file.

Read More →

Why Use a Help Authoring Tool Instead of Microsoft Word to Produce High-Quality Documentation?

Why Use a Help Authoring Tool Instead of Microsoft Word to Produce High-Quality Documentation?
Categories: articles

When it comes to creating high-quality help files, user manuals, documentation websites, or eBooks, Microsoft Word is not the best tool for the job. In fact, it can be a real pain to use and the results are often far from satisfactory: managing multiple interconnected documents with Microsoft Word is very hard, error-prone, and time-consuming. A Help Authoring Tool (HAT), such as HelpNDoc, is much simpler, faster, and therefore cheaper to use.

Read More →

How to setup and update pictures’ properties throughout your documentation projects

How to setup and update pictures' properties throughout your documentation projects
Categories: articles

Managing media assets such as pictures throughout help files, documentation projects or ebooks can be a daunting task and this is why the HelpNDoc help authoring tool implements a centralized library: media assets are managed from the project’s library, and changes are automatically applied to every instances throughout the project. But some settings (such as dimensions, positions, alterative texts…) can be customized for each instance, making them hard to update for frequently used assets.

Read More →

How to convert a Word document to a clean, responsive HTML 5 website

How to convert a Word document to a clean, responsive HTML 5 website
Categories: articles

Microsoft Word, and similar word processing software such as LibreOffice, are great to write and format documents meant to be printed, but not so good at producing HTML websites from those documents: they generate suboptimal single-page HTML / CSS code which is not optimized for different screen sizes and devices such as smartphones. By leveraging the import and export capabilities of a help authoring tool such as HelpNDoc (which is free for personal use), it is extremely easy to convert a Word document to a fully functional multi-page and responsive HTML 5 website.

Read More →

Produce a Rich Text Format (RTF) file from your documentation project using the HelpNDoc help authoring tool

Produce a Rich Text Format (RTF) file from your documentation project using the HelpNDoc help authoring tool
Categories: articles

Even though the Microsoft Rich Text Format (RTF) could be considered as a legacy document format, it is supported by enough software and operating systems to be considered as highly portable and a great choice for cross-platform document exchange. Thanks to the HelpNDoc help authoring tool, you can produce your documentation projects not only as Microsoft Word DocX documents, but also as fully valid RTF documents, giving you a great choice of document format generation options.

Read More →

Context sensitive HTML help and URL aliases for help topics in your HTML documentation web-sites

Context sensitive HTML help and URL aliases for help topics in your HTML documentation web-sites
Categories: articles

One of the most important help file format produced by the HelpNDoc help authoring tool is the HTML documentation format: the fully functional documentation web-sites can be hosted on any web server for quick access to self-service documentation, thus simplifying customer accessibility and the work of the support team. Support agents frequently need to share context-sensitive URLs to customers to explain specific tasks but those are often too long and hard to remember and type.

Read More →

3 ways to speed-up hyperlink creation in your help file, user manual or eBook

3 ways to speed-up hyperlink creation in your help file, user manual or eBook
Categories: articles

Technical writers are spending a lot of time making sure that the content they are writing is relevant, clear, and concise so they should not have to waste time operating their favorite help authoring software when they need to perform common tasks such as creating hyperlinks. Fortunately, the HelpNDoc help authoring tool provides multiple ways to speed up hyperlink creation, thus helping technical writers spend their time where it matters the most: writing great content.

Read More →