Wiki Tag: quality assurance

Purpose of Style Guides

A style guide (or style manual) is a set of standards for writing and designing documents, either for general use or for a specific publication, organization, or field. Usage Using a style guide provides uniformity in style and formatting of a document. Good practice dictates that the style guide be easily accessible and used by all members […]

Reviewing

About Reviewing Reviewing is the process of providing feedback on material produced by another writer (or group of writers). Changes are not made in the material but can be provided in the form of: A separate document or email that contains the feedback Comments within the documents itself A face-to-face discussion Defining a review Which […]

Quality Assurance

Quality assurance includes a wide range of practices, including controlled languages, editing, reviewing, style guides, testing, and evaluating quality to name just a few. Controlled languages Editing Reviewing Style guides Testing Evaluating Quality Plagiarism Contributors must be aware that committing plagiarism is an act of fraud. The TCBOK is not responsible for plagiarized submissions. Any […]

Editing

About Editing Editing is the process of correcting or adjusting a document before publication or distribution. It is an important part of quality assurance. The Editing Process Which issues are fixed during editing, and which are addressed during the review process? That must be agreed upon by the parties who are involved. Most commonly, editing technical documents involves concentrating on […]

Controlled Languages

About Controlled Languages Controlled languages (sometimes called controlled natural languages or CNLs) are subsets of human  languages, such as English or Chinese. Controlled languages use restricted grammar rules and vocabularies (typically between 800 and 1,000 words) to reduce or eliminate ambiguity and complexity. They are often used to simplify technical communication, especially for the benefit […]

Technical Communication Body of Knowledge © 2017 Frontier Theme