In this section, we publish articles dedicated to effective work in the Dr.Explain program, as well as useful materials on documentation development, technical writing, and software maintenance.
Digitization is sweeping across many areas of business, and in industries where accuracy is critical, specialized software is no longer necessary. New technologies optimize costs and minimize the likelihood of errors. This is especially true in the production of industrial equipment.
Ordinary text instructions cannot fully explain the benefits and reveal the potential of a complex business process automation system. If the user does not understand the advantages of its application, he will consider it unnecessary and useless.
It is wrong to think that people who have been working with numbers and complex accounting programs all their lives will easily master any software. Software that they can navigate even with their eyes closed has taken them decades to master and initially caused difficulties. How to make the accounting system understandable? What will make the new development the accountant's favorite tool?
Sometimes a company implements an ERP system, but without the desired effect. It's all about complexity, which discourages employees. Here are examples of effective user documentation and tools for writing them.
A CAD and BIM system without user manual is a serious miscalculation. BIM and CAD user manual written in MS Word is a fatal mistake. What tools are industry leaders using to write effective user manuals?
Broken windows theory is the concept that small irregularities left unattended can lead to more serious problems. In this article, you will learn how to keep your project up to date and avoid project obsolescence.
What is user-friendly interface? How to create it? What are its key features? Examples of a good interface in technical documentation.
SaaS or desktop software — what is better for writing technical documentation?
Designing and writing good documentation is a job that takes a lot of time and effort. But if you successfully cope with the task, you can get loyal and satisfied customers forever.
Best programms and services for creating user manuals
All software, from simple command line utilities to large scale corporate systems, needs documentation. It may be done either in the form of several text strings shown in a console window or in the form of thousands of web pages stored on the company portal in a distributed database. No mater how documentation is done, it must be done.
Index is not a brand new thing to people. You can find it in textbooks, encyclopedias, handbooks, manuals. Generally index is an alphabetically sorted list of words with page numbers (or hyperlinks to pages) where they are mentioned. The reason why end-user program documentation demands index is that it can be easily interpreted as ordinary book.
Unfortunately, nobody wrote instructions for Agile technical writers, so peculiarities of profession need to be studied out.
To do your best as a technical writer in scrum team check out several must-know things below.
Are you still wondering which help file format to use for your Windows software? The selection depends on your software and on the information that is in your help files. Each help file format has its own unique features that may be useful in certain situations. Generally, I would recommend that you use different help files for different situations.
Some or even all of your CHM files seem to have gotten corrupted. They show a The page cannot be displayed error in the left-hand pane of the CHM viewer. There are several possible reasons why your CHM help files are unreadable.
There are several main reasons why putting your software manual on-line is necessary. It makes your web-site attractive for search engine crawlers and therefore brings you targeted traffic from Google, Yahoo!, MSN, and other search engines.
Even if your manual isn't being helpful to your software users, it may be helpful to you. Publish your help manual online and turn its hidden power into a real benefit for your business.
Context help is a user manual that is embedded into the web application or a website and provides just in time access to the information about specific page elements
This article is devoted to creation of help file in CHM format and its further integration into the .NET application. Code samples are included.
This article is devoted to creation of help file in CHM format and its further integration into the Visual Basic (VBA.NET) application. Code samples are included.
This article is devoted to creation of help file in CHM format and its further integration into the Microsoft Excel workbook. Code samples are included.
This instruction describes the process of creation of Help file for Microsoft Access in Dr.Explain and its subsequent integration into the forms of data base
The article describes how to create a context sensitive help file in Dr.Explain software and to use it in a Delphi project. Code samples are included.
In the ten years that we’ve been developing Dr.Explain, a leading-edge tool for creating help files, we saw hundreds of our customers' projects. Our technical support team mostly receives user documentation for software products with requests to help implement some tricks.
Dr.Explain allows you to create a user guide or technical documentation in multiple formats based on one project. It takes only a couple of clicks to export the documentation to one of these popular formats: PDF, CHM, Microsoft Word, or online help ready to publish on the Web
An obvious choice of the format for publishing online help is HTML or, to be more exact, DHTML (Dynamic HTML). The documentation will consist of HTML files, image files, and JS (JavaScript) files