The contribution deals with the transposition of projects on the basis of the AECMA-1000D-specification. The author explains problems which exist outside aeronautics with the application of this specification.
Auditing and enforcing compliance with P&P content should not be the responsibility of a P&P group or included in the job description of a P&P practitioner. However, the charter or job description may state that P&P practitioners are responsible for supporting compliance efforts.
There are a number of tools available for transforming DocBook XML documents to various formats. All of these tools have strengths, as well as some noticeable weaknesses and drawbacks. This article looks at the benefits of using the XMLmind FO Converter, a graphical, highly configurable, and cross-platform application designed to transform DocBook XML files to any supported output format.
Describes how technical writers can make their documentation comply with ISO 9001, the latest quality management system from the International Organization for Standardization. The article includes a list of suggested readings.
Most technical writers understand online help formats and have worked with at least one over the years. Help file format have evolved from man pages (manual pages in UNIX in the early 1970’s) and HLP files through CHM files and the plethora of HTML-based formats that we have now. E-Book formats are similar in many respects to the common online help formats, but with one crucial difference; they’re designed to work on the small screens of today’s e-readers and tablets.
Industry best practices are business processes that assist companies, government agencies, and non-profit organizations in maintaining the highest level of quality in the products or services that they are offering. A lot of it might seem like common sense, but if you saw some of the things that I have seen in the different projects I’ve been on, you’d realize that sometimes you can just rely on that. Here are five industry best practices that you should adopt, regardless of the type of organization that you are running.
This chapter is intended to provide a quick introduction to structured markup (SGML and XML). If you're already familiar with SGML or XML, you only need to skim this chapter. To work with DocBook, you need to understand a few basic concepts of structured editing in general, and DocBook, in particular. That's covered here. You also need some concrete experience with the way a DocBook document is structured.
Most people involved with authoring and reviewing process do not have good markers to inform them of the overall communication quality of a document. So without good markers they are left to utilize really poor markers to help them measure document quality.
Information Mapping is a proprietary method for the analysis, organisation, and presentation of information. It is based on the needs of the users and their purpose in using the documentation. Information Mapping has three parts: analysis, organisation, presentation.
In our consultancy, we have developed a set of terms that represent what we consider to be an effective set of descriptive markers. Markers that help to measure how well a document is communicating. We characterize our set of markers as “Document Standards” for all forms of technical and scientific writing.
People use different terms to describe quality and if they actually use the same term, then it is highly unlikely that they will use the same definition for the term. So the first problem faced in the review process is the vocabulary used to describe quality attributes in a document.
DocBook is a powerful tool for creating and maintaining documentation. However, there are a number of factors you should consider before you move your documentation to DocBook. This article discusses reasons for and against making the switch to DocBook.
The EU directive 92/58/EWG of 24th June 1992 clearly defines the notification on occupational Safety and Health Safeguards. In Germany, this has been enforced through the regulations for trade associations BGV A 8 (formerly VBG 125) which regulate indication of occupational safety and health safeguards through prohibition signs, warnings, instructions or signs for action, rescue, fire protection and so on. At present there is no European standard that discusses the topic of 'Drafting Safety Instructions in Operating Manuals' adequately and in detail. Nonetheless, there are several sources but often containing only imprecise or too generalized requirements. Moreover, many judicial verdicts in various individual cases point to the manner of formulations in Safety Instructions.
This paper, the second of a series, closes the loop by examining implementation issues from a technical perspective. It explores best practices within the five key steps of a successful transition.
Organizations develop policies and procedures to support industry certification and compliance requirements. Unfortunately, companies often develop P&P information that is not helpful to all employees who must use the information. In fact, one study found that 40 percent of U.S. companies failed ISO certification because of problems with unclear or missing P&P documentation, resulting in wasted time, money, and effort.
Experts from around the World are working on a new ISO standard for software documentation (Guidelines for the design and preparation of user documentation for application software). This article outlines how the standard is being produced, its current status and what it contains.
Managing for quality requires effective, enforced standards. Effective standards make it possible for everyone on the information team to be responsible for quality – for what J.M. Juran has called 'fitness for use.' This paper examines why standards improve quality and what actions are necessary to manage for quality by creating and using effective standards.
Today, Help authors take HTML for granted. But XML is starting to displace HTML, bringing with it new technologies like DITA and Web 2.0, as well as the potential for disruption. Perlin examines how to prepare for the change through adhering to standards.
Is your documentation and training a solution for complex product design? Whether designing software, hardware, documentation, online help, or a telecommunication network, a strategy for usability is essential to user-friendly design. Every organization has a product life cycle but not every organization is user-focused because of absence of a usability process. Where do you begin? This paper describes two ISO standards that I have used as a strategy for usability, and accompanies a presentation that demonstrates how to put the standards to practice.