Mathematical symbols. Statistical symbols. Chemical formulae. References in a document to itself. Cross-references to a numbered document. Cross-references to an unnumbered document.
Cross-references to a document that is not yet published. Cross-references to a withdrawn document. References within the document. References to websites. References in Clause 3 Terms and definitions. Order of normative references.
Order of bibliographic references. Use Plain English to explain the subject of a document as simply and effectively as possible. Plain English is easier to read, which results in less misunderstanding and misapplication of instructions. ISO documents have international users who often read in their non-native language.
ISO documents are also often translated. Clear and concise writing avoids errors in translation. Plain English is not unprofessional or informal; it is a tool of good communication. Grammar is everything known about the structure of a language. It is a big topic beyond the scope of any style guide. However, here are answers to some common questions. In any clause of a sentence, the verb must agree with its subject in terms of singular or plural.
For example:. For singular collective nouns nouns that refer to a group of individuals, e. A relative clause is the part of a sentence used to describe a noun. It comes immediately after the noun it describes. There are two types of relative clauses:. In the first example sentence, the ISIN is allocated only to those products that are not financial instruments.
Removing it would change the meaning of the sentence. If it was removed, the sentence would retain its meaning. Affect verb means to have an influence on, e. Effect verb means to cause or to accomplish, e. Effect noun means a change or result caused by something or someone, e.
Ensure verb means to make sure of something, e. Use the full forms instead. ISO documents use Oxford English spelling, which is British spelling in combination with the suffix -ize rather than -ise for about verbs that originate from the Greek -izo suffix, e.
In case of doubt, follow the spelling of the Oxford English Dictionary. For an online version, see www. Use spelling consistently throughout a document. Spelling exceptions are allowed for technical reasons. Use sulfur and not sulphur Use sulfate and not sulphate Use sulfide and not sulphide.
Follow the spelling of proper nouns and words from foreign languages, including accented letters, cedillas, ligatures or other special marks and any alphabetical forms that do not normally occur in English. Reproduce the names of foreign companies as used by the company itself, with all the appropriate characters French accents, Spanish tildes, etc. Avoid the use of Latin words as far as possible. Use Plain English instead. Italicize Latin words used for scientific terms, e.
In some cases, both forms are still used. For Latin and Greek words, use the English plural if one exists, e. Otherwise, use the appropriate foreign plural forms that are still commonly used.
In modern English usage, it is often treated as a mass noun with a singular verb. Use lower case for general IT terms e. See Legal statements. If there is a need to define this kind of terminology in a standard, search the Online Browsing Platform to find the CASCO definition to use as a source.
Do not develop a new definition for the document. It is permitted to refer factually to the law and regulations to explain how they relate to the subject of the document. See the Guidance on legal statements in ISO standards. When referring to the law, use clear language so the user understands the meaning. Remember that informative annexes can contain requirements that apply if the user chooses to implement the annex. Do not label any other titles of elements of the document clauses, subclauses, tables, figures, etc.
Unless there is a clear requirement "shall" or imperative language in the text, all document content is informative by default.
The subtle differences in meaning are not easily translated into other languages when ISO documents are used around the world.
Do not use the terms "round robin" or "ring test" instead of "interlaboratory". Avoid using words that are unnecessarily gender specific. Avoid stereotyped assumptions about the roles of men and women or people of different ages and backgrounds. For example, do not assume that a construction worker is a man or that an older person does not possess skills in using modern technology. When writing about groups of people, use language that highlights that they are individual people with X characteristics in common rather than a group defined only by that characteristic.
Avoid terminology related to race. Use capitals sparingly. The use of many capitals makes a page look bureaucratic or pretentious, especially when ordinary words such as method or framework are unnecessarily capitalized.
Otherwise, nouns are given in lower case, i. If the full form of an abbreviated term is not a proper noun, the abbreviated term is generally presented in capital letters, e.
DMA, but the full written form is not given initial capital letters, e. In titles and headings, only the first word is capitalized, except for proper nouns, acronyms or initialisms. They are formed from the initial letters of other words. Exceptions can be made when the abbreviated term is so familiar that it is used more often than the full form, e. If a list of abbreviated terms is given, it is not necessary to spell out the full term at the first use but it is allowed. In terms and definitions, the full term is spelled out at the first use in each entry.
This is because terms and definitions are available as standalone items on the Online Browsing Platform. Either form can be used providing its use is consistent. Do not use capital letters for the full term unless it is a proper noun, see Capitals.
If the abbreviated term can be pronounced e. Otherwise, it is preceded by an article e. Exceptions include abbreviated terms that are already plural, e. Abbreviations and contractions are shortened words. These are not included in a list of abbreviated terms. An abbreviation has the beginning of a word but not the end. Put a full stop after the abbreviation and capitalize it in the same way as the unabbreviated word. Only use abbreviations in tables and figures; write words in full in the text.
A contraction has the first and last letters of a word and sometimes other letters in between. Contractions have no full stops. They are also capitalized like the uncontracted word. These common Latin shortened forms are used regularly in ISO documents. They are punctuated as shown:. Never include both e. Punctuation helps make meaning clear, but there are changes in practice over time and different writers adopt different approaches.
The priority for ISO documents is to be easily understandable and unambiguous. Use punctuation consistently within a document. The meaning can often be made clearer by rewording, e. Do not use an apostrophe for plurals of names, abbreviated terms, numbers or words not usually used as nouns, e. Sometimes clarity is needed when letters and symbols are referred to as objects, e. In these cases, use quote marks and not apostrophes, e. ISO documents do not use the Oxford serial comma before the last item in a list, unless it is needed to avoid ambiguity.
Use plenty of full stops. They keep sentences short. This helps the user. Hyphens in words or phrases can improve clarity and avoid misinterpretation. Use hyphens consistently throughout a document or series. A word formed from a prefix plus a word is not usually hyphenated unless the word begins with the same letter as the last letter of the prefix:. Words beginning with co- meaning joint , anti-, non- and ex- meaning former tend to keep their hyphen, e. Words formed with suffixes are generally not hyphenated, e.
Compound nouns are usually presented as a single word with no hyphen or as two separate words, e. Exceptions include cross-reference and decision-making. Compound adjectives that modify the noun are hyphenated when they come before the noun, e.
Do not use a hyphen when the compound comes after the noun, e. Do not hyphenate compound adjectives when the first word is an adverb ending in -ly, e. A list can be subdivided up to four levels. If more levels are required, consider using a table or splitting into several shorter lists. For an unnumbered list, an em dash "—" is used for the bullet symbol at all four levels. The default order for a numbered list is a , b , c for the first level; 1 , 2 , 3 for the second level; i , ii , iii for the third level; and a , b , c for the fourth level.
Use numbered lists so that it is easy to cross-reference a specific list item, e. Try to keep lists short so that they are easy to use. If a list requires a lot of subdivision or runs over several pages, try to break it down into several shorter, simpler lists. No punctuation is required if the list items are very short one or two words each or if the bulleted list is in a table, for example:. When the quote is a full sentence and stands completely alone, put the punctuation mark e.
When the quote is within a sentence and the punctuation mark is part of the quote, keep it within the quotation marks. When the quote is within a sentence and the punctuation mark is not part of the quote, place it outside the final quotation mark.
Use spaced em dashes — between the elements in titles and between figure or table numbers and titles:. Use closed-up en dashes — in ranges in references, e. Spaced en dashes can be used as parenthetical dashes, e. Use an en dash instead of a hyphen between two names to show joint authorship or ownership, e. The rules for the representation of numbers and values are given in 9. In general, write numbers as words up to nine and use digits after that.
However, exceptions can be made to improve readability. Be consistent within sentences, e. Use words for approximations, e. Use digits with units of measurement, amounts of money and ages, e. Use digits if numbers are being compared, e. Use words if the number starts a sentence, e. There is no need to also give the digits in brackets following the words. If the number is very long, try to redraft the sentence, e. Sometimes using a variety helps to make the meaning clear, e.
Give the date instead. The rules for the representation of symbols for quantities and units and for mathematics are given in Clause 9, Clause 27, Symbols for quantities are presented in italics.
Words or numbers are presented in upright characters. Do not use multi-letter abbreviated terms as symbols for quantities. Symbols are used in mathematical formulae and figures; abbreviated terms are used in the text.
Symbols for quantities are generally a single letter Latin or Greek, lowercase or uppercase , except for characteristic numbers covered in ISO Use one symbol to represent similar quantities. Do not use the same symbol to represent different quantities.
For example, if several lengths are given in the document, use the symbol "l". Do not then use "l" to represent a different quantity. Add subscripts to symbols to distinguish between similar quantities. Subscripts can be numbers e. When the subscript is a quantity or a mathematical variable, it is also presented in italics.
Otherwise, it is upright. Unit symbols can be one or more letters Latin or Greek, lowercase or uppercase and are always upright. When non-SI units need to be used, give the equivalent value in SI units in brackets. Some equivalent units use a decimal point rather than a decimal comma, e. In figures, X, Y and Z axes are shown in uppercase upright. Greek letters used in chemical names are upright e.
ISO Technical product documentation — Parts lists. ISO Technical product documentation — Design for manufacturing, assembling, disassembling and end-of-life processing — Part 1: General concepts and requirements. ISO Technical product documentation — Vocabulary — Terms relating to technical drawings, product definition and related documentation. ISO Diagrams for the chemical and petrochemical industry — Part 1: Specification of diagrams.
ISO Technical product documentation — Use of main documents. ISO Technical product documentation — Handling of computer-based technical information — Part 1: Security requirements.
ISO Technical product documentation — Handling of computer-based technical information — Part 2: Original documentation. ISO Technical product documentation — Handling of computer-based technical information — Part 3: Phases in the product design process.
ISO Technical product documentation — Handling of computer-based technical information — Part 4: Document management and retrieval systems. ISO Technical product documentation — Handling of computer-based technical information — Part 5: Documentation in the conceptual design stage of the development phase. ISO Technical product documentation — Document management.
ISO Technical product documentation — Life cycle model and allocation of documents. ISO Technical product documentation — Protection notices for restricting the use of documents and products.
ISO Technical product documentation — Digital product definition data practices. ISO Technical product documentation — Document types.
IEC Industrial systems, installations and equipment and industrial products — Structuring principles and reference designations — Part 2: Classification of objects and codes for classes. ISO Industrial systems, installations and equipment and industrial products — Structuring principles and reference designations — Part Construction works and building services. ISO Design of graphical symbols for use in the technical documentation of products — Part 1: Basic rules.
IEC Design of graphical symbols for use in the technical documentation of products — Part 2: Specification for graphical symbols in a computer sensible form, including graphical symbols for a reference library, and requirements for their interchange. IEC Design of graphical symbols for use in the technical documentation of products — Part 3: Classification of connect nodes, networks and their encoding.
ISO Document management — Part 5: Application of metadata for the construction and facility management sector. IEC Preparation of instructions for use — Structuring, content and presentation — Part 1: General principles and detailed requirements.
Many of them might not be big fans of reading, so make the documentation as visual and easy to understand as possible. You might want to include simple language and terms that everyone is familiar with.
Try not to squeeze too much information in one document, however, also try not to create too many different documents on the same topic. This causes over bureaucracy and is all but easy to understand. If not, here are some recommendations on what to take into account when writing ISO compliant work instructions:.
Now you know how to write ISO compliant work instructions. If you need more help on how to write any good work instructions not just ISO compliant , our »Tips on how to write good work instructions« might be a good place to get started.
0コメント