The information that a company distributes is never in a vacuum. Instead, it affects the content of many internal and external processes and, therefore, the content of user documentation in particular. If, for example, developers adjust the functionality of a software package, the interface also changes. Both of these aspects must also be replicated in the product documentation. So why not “simply” connect the two together, for example by coupling the CMS to the development process and using it as an analysis tool for content quality as well? Continue reading
Quality assurance of technical documentation is often ensured by means of the four-eyes principle. However, time and time again, small errors or imprecisions still find their way into texts, even after careful checking. It would be useful to conduct an automated check according to formal rules, such as upper/lower case in headings. This is what the validation language Schematron (an ISO/IEC standard) does. It provides the opportunity to analyse and check text content available in XML, both automatically and with sensitivity to context. Continue reading
Many customers who are interested in a content management system make the mistake of only considering price and features during the selection process.
Whether one will be satisfied with the purchase in the long run is not defined by the sales person who once presented the system but by the factors that can hardly be perceived in a presentation. Among those are:
- quality of the software
- innovation and continually ongoing development
- training, service and hotline
We have all been through this: Your documents passed all reviews, any corrections were entered to the best of your knowledge. The document returns from printing. The first person to look at it instantly spots at least three mistakes. In fact exactly the same ones that all those involved in the process had already overlooked the last time.
Or: Your service provider delivers the documents created by him shortly before editorial deadline and again not all specifications from the editorial style guide have been observed.