HP TextEngineer Technical Writing Guide User's Manual
Contents
1. 1 1 1 and after lower level step letters and numbers e g a 1 Place colons after statements that are followed by lists such as lists of individual components e Bullets e should be used in a list instead of numbers or letters when numbering serves no purpose or no reference to specific item s in the list will be made 1 4 CAPITALIZATION The trend in most corporate and technical writing is to eliminate unnecessary capitalization Use capitalization only as described below Capitalize the first letter of the following e Each main word in subsection headings e First word in a sentence e First word in each phrase used in a list e Proper nouns such as vendor or organization names e Full titles of formal programs and documents e Specific company product names Strunk William and E B White The Elements of Style For Illustration Only 1 6 Company Writer s Guide Capitalize all letters in each of the following e Main section headings e Acronyms initialisms Do not capitalize e Generic product and component names for example controller panel switch e Generic system names e Acronym definitions unless they belong in the above initial cap group Capitalize the first letter of Government Division Plant Project etc when referring to a specific one Use lower case when it is only a general reference 1 5 NUMERALS AND UNITS Both Arabic and Roman numerals may be used in company document2. carbon steel n um centerline changeout close up closeout coauthored common mode um constructibility cooldown n um cooperate cost effective um creep down um crossover cutset database datalink DC For Illustration Only 1 11 deadman deadweight decision making um decision set um de energize diesel generator um double check v n um driveline E C engineer constructor electromechanical e mail employee ensure not insure entry level Environmental Safety and Health ES and H etal etc fail closed um failover feedback fiber optic um flow path flow rate followup foot foreword freestanding front line um full penetration um full scope um full time um FY 2002 ground level um groundwater handhole Company Writer s Guide hard copy um hard face um hard rock um hard wired heatup um high build um high energy um high level um hold down um holdup hot dip um human factor um in depth um in flow um in house um in leakage um in service um inside diameter in situ um in tank um interrelated January 2002 kV large scale um latch locking um layout leak off n um leaktight leaktightness lifetime lift off n um locked closed um log normal um long lead um longstanding low level um For Illustration Only 1 12 low pressure um makeup make or buy um man hours manway mid size
3. SI unit of pressure or stress see pascal nit nt 1nt 1 cd m The name nit is sometimes given to the SI unit of luminance the candela per square meter The oersted is the electromagnetic CGS unit of magnetic field strength Deprecated see ANSI Z210 1 1976 ohm SI unit of resistance pascal 1 Pa 1 N m SI unit of pressure or stress pascal second SI unit of dynamic viscosity peta SI prefix for 10 phot 1 ph Im cm CGS unit of illuminance Deprecated see ANSI Z210 1 1976 picofarad picowatt pint 1 pt UK 0 568 26 L 1 pt US dry 0 550 61 L 1 pt US liquid 0 473 18 L For Illustration Only B 14 Company Writer s Guide Symbols for Units in General Use Cont d pound force per square foot _ Ibf ft pound force per square inch lbf in EEE use of the abbreviation psi is common it should not be used as a symbol EC S quart qt 1 gt UK 1 1365 L 1 qt US dry 1 101 2 L 1 qt US liquid 0 946 35 L rad rd A unit of absorbed dose in the field of radiation dosimetry Use of the SI unit the gray is preferred 1 rd 0 01 Gy rem rem A unit of dose equivalent in the field of radiation dosimetry Use of the SI unit the sievert is preferred 1 rem 0 01 Sv revolution per minute r min Although use of rpm as an abbreviation is common it should not be used as a symbol e roentgen A unit of exposure in the field of radiation dosimetry second plane angle e siemens S
4. 1S 1Q9 SI unit of conductance The name mho has been used for this unit in the USA sievert SI unit of dose equivalent in the field of radiation COC Name adopted by the CIPM in 1978 For Illustration Only B 15 Company Writer s Guide Symbols for Units in General Use Cont d aww e ooo C Cc C S A CGS unit of luminance Deprecated see ANSI Z210 1 1976 Deprecated see ANSI Z210 1 1976 SI prefix for 10 tesla 1 T 1N Aem 1 Wb m SI unit of magnetic flux density magnetic reduction 1 ton 2000 Ib ton metric 1t 1000 kg The name tonne is used in some countries for this unit but use of this name in the USA is deprecated see ANSI Z210 1 1976 unified atomic mass unit u The unified atomic mass unit is defined as one twelfth of the mass of an atom of the C nuclide Use of the old atomic mass unit amu defined by reference to oxygen is deprecated var IEC name and symbol for the SI unit of reactive power For Illustration Only B 16 T therm 1 thm 100 000 Btu var V V m Company Writer s Guide Symbols for Units in General Use C voltampere IEC name and oo u for the SI unit of apparent e SSO S W mek SI unit of thermal seot oo watt per steradian square W srem SI unit of radiance meter a weber Wb Ves SI unit of magnetic flux e a For Illustration Only B 17
5. ANSI Z210 1 1976 cubic centimeter cm A unit of activity of radionuclide Use of the SI unit the becquerel is preferred 1 Ci 3 7 x 10 Bq cycle per second See hertz The name hertz is internationally accepted for this unit the symbol Hz is preferred to c s For Illustration Only B 6 Company Writer s Guide Symbols for Units in General Use Cont d 1 D 1cP cm s cm atm 0 986 923 um A unit of permeability of a porous medium By traditional definition a permeability of one darcy will permit a flow of 1 cm s of fluid of 1 cP viscosity through an area of 1 cm under a pressure gradient of 1 atm cm For nonprecision work 1 D may be taken equal to 1 um and 1 mD equal to 0 001 um Deprecated see ANSI Z210 1 1976 day Oo degree temperature degree Celsius SI unit of Celsius temperature The degree Celsius is a special name for the kelvin for use in expressing Celsius temperatures or temperature intervals SI prefix for 10 Deprecated see ANSI Z210 1 1976 ce Deprecated see ANSI Z210 1 1976 For Illustration Only B 7 degree Fahrenheit F Note that the symbols for C F and R comprise two elements written with no space between the and the letter that follows The two elements that make the complete symbol are not to be separated Company Writer s Guide Symbols for Units in General Use Cont d CC a aw o S w oo e SSS a a fc footcandle 1 fc
6. lm ft A unit of illuminance and also a unit of luminous existence Use of the SI unit lumen per square meter is preferred Im m SI unit of luminous existence conta maxwell of magnetic flux Deprecated see ANSI Z210 1 1976 SI unit of illuminance The maxwell is the electromagnetic CGS unit SI unit of length meter For Illustration Only B 11 Company Writer s Guide Symbols for Units in General Use Cont d pee 1 t 1 000 kg The name tonne is used in some countries for this unit but use of this name in the USA is deprecated see ANSI Z210 1 1976 mio ato Pometuseasenaneartesenes 8 oo a C E E C mwa o e PS e S microsecond s o e a C C common it should not be used as a a _ e eee Z210 1 except for limited use in meteorology a a C For Illustration Only B 12 Company Writer s Guide Symbols for Units in General Use Cont d pme a ee S conventional millimeter of mmHg 1 mmHg 133 322 Pa deprecated mercury see ANSI Z210 1 1976 millimicron Use of the name millimicron for the nanometer is deprecated mPaes SI unit multiple of dynamic viscosity ee oO es superscripts as in the following example minute time 9 46 30 mL mm m mi Np N em Time may also be designated by means of ay n n C a C n n n n For Illustration Only B 13 Company Writer s Guide Symbols for Units in General Use Cont d newton per square meter N m
7. um mockup multicompany multimillion Navy nil ductility no load um non Class 1E non conformance non exempt non process offeror offgas off line um off load offset offsite onboard on call um on line um on schedule um one half all cases ongoing onset onsite outside diameter overwrite partial penetration um pathway percent pinhole Company Writer s Guide post heat post test preheat preoperational pre procurement pre service um proactive pushbutton read out n um real time um record keeping um remote handled um roundtable self sufficient um set point shear wave um shutdown sign off n um socioeconomic soil structure um stand alone standup startup state of the art um Statement of Work subassembly subunit thousand through wall um time history um Notes time out Title II topcoat trade off n um two dimensional um Type 304 Type A U S um unisolatable United States n up front um VAC VDC versus videodisk videotape walkdown warmup water reducing um watertight wave front um work around n um work scope workday workstation world class um 0 5 1990s 1 Certain compound or joined words may become two words when used as a verb Example We will start up the process next month 2 Certain words are hyphenated when they are adjectives unit modifiers but not when they stand alone Example The co
8. used only when necessary and when their meanings are unquestionably clear When in doubt spell it out In the text capitalization will agree with the parent word Rules of capitalization apply The same abbreviation should be used for all tenses possessive singular and plural A sentence should never begin with an abbreviation except where the parent word s would result in an awkward construction The following pages contain basic rules to use when abbreviating and a list of engineering unit abbreviations in their proper form 1 Abbreviations should be spelled out in all possible circumstances However when abbreviations are necessary use the following guidelines a The trend is to omit periods from all abbreviations except where they have traditionally appeared for example U S Ph D Mr Mrs b There should be no space after the internal periods within a traditional abbreviation for example a m U S i e etc c An abbreviation needs no period unless it can be confused with a word e g in a m no One exception to this rule is a period usually is not necessary in tabular material 2 The following common Latin abbreviations should appear as i e that is e g for example et al and others etc and so forth A comma should precede and follow the above abbreviations when used in the middle of a sentence 3 versus should be spelled out not vs For Illustration Only B 1 C
9. 1lm ft The name lumen per square foot is also used for this unit Use of the SI unit of illuminance the lux lumen per square meter is preferred lumen per square foot leaves a surface whose luminance is one footlambert in all directions within a hemisphere Use of the SI unit the candela per square meter is preferred footlambert 1 fL 1 1 cd ft A unit of luminance One l Gal 1 Gal 1 cm s deprecated see ANSI Z210 1 1976 1 gal 4 5461 L 1 gal 231 in 3 7854 L The gauss is the electromagnetic CGS unit of magnetic flux density Deprecated see ANSI Z210 1 1976 For Illustration Only B 8 Company Writer s Guide Symbols for Units in General Use Cont d gigaelectronvolt GeV gigahertz GHz gilbert grain gr gram gram per cubic centimeter g cm a eao o h hecto henry hertz horsepower hp inch conventional inch of inHg mercury conventional inch of inH O water inch per second in s joule per kelvin J K The gilbert is the electromagnetic CGS unit of magnetomotive force Deprecated see ANSI Z210 1 1976 SI unit of absorbed dose in the field of radiation dosimetry SI prefix for 10 SI unit of inductance SI unit of frequency The horsepower is an anachronism in science and technology Use of the SI unit of power the watt is preferred 1 inHg 3386 4 Pa ISO 1 inH O 249 09 Pa ISO SI unit of energy work quantity of heat SI unit o
10. Company Writer s Guide SECTION 1 STYLE GUIDE This section of the Writer s Guide is intended to establish a basic writing style that is clear concise and consistent in presentation of information Technical information requires more stringent standardization than is common in general usage Therefore generating a deliverable to accommodate an expeditious technical review requires avoiding confusing or ambiguous statements and unnecessarily verbose descriptions 1 1 WRITING STYLE APPROACH Avoid use of colloquialisms in writing Terms like putting your best foot forward or cutting to the quick can be misunderstood by international customers and lead to confusion Conversational English is inappropriate for formal business and technical writing Keep language clear and precise The following guidelines will help improve your writing and allow us to present a standardized look and feel in deliverables to customers Great Content Economically Delivered The most effective technical writing is taut information rich material that easily conveys the most important points Here are some ways you can achieve this 1 Try to restrict acronym use to the five to ten most important acronyms in a subject area and write out the secondary or peripheral terms 2 Always write in a simple and direct style by avoiding e Wordiness examples of wordiness appear in Table 1 1 1 e Strings of adjectives e Puffery Our company is unique
11. bers Tables will be assigned table numbers When using graphics observe the following e Cite all graphics in text with corresponding numbers e Number in sequence by second level section Figure 1 1 1 is the first figure cited in Section 1 1 Table 1 1 1 is the first table cited in Section 1 1 etc If a graphic is cited in the text of a top level section the numbering is 1 1 1 2 etc e Capitalize the initial letter of the words figure and table when they appear with a number otherwise use lower case the figure shows the difference between 1 8 EDITING CONVENTIONS Many words and phrases can be written more than one way Every project should use the broad list of writing conventions preferred terms spellings punctuation in this section and define additional conventions as needed to promote consistency among documents In the list when a phrase is to be hyphenated in adjectival use as a unit modifier um that note accompanies the phrase Other abbreviations in the list include n for noun and v for verb While this may be useful for reference engineering authors should not spend precious time worrying about these details For Illustration Only 1 10 Company Writer s Guide AC air flow Alloy 750 around the clock um ASME Code B S M S backfit backflow backlit backpressure backup best estimate um boil off n um break even um Btu buildup built in um buses bypass
12. d works are handled as follows e Author s last name comma first initial comma Additional names in normal order first initial last name period e Title of book article or paper period e Title of journal or larger work in italics comma e Volume and number information if applicable period e City colon publishing body if applicable period e Date period Examples of published works Adams M J Y J Tenney and R W Pew Situation Awareness and the Cognitive Management of Complex Systems Human Factors 37 85 104 1995 Brannick M T E Salas and C Prince Team Performance Assessment and Measurement Mahway NJ Lawrence Erlbaum Associates 1997 Cannon Bowers J A and E Salas Making Decisions Under Stress Implications for Individual and Team Training Washington D C American Psychological Association 1998 4 Manual titles are usually underlined For Illustration Only 1 9 Company Writer s Guide 5 The ordering of documents in the reference list should correspond to the sequence of references used in the document so that Reference 1 is the first one used 2 the second and so on 6 Reference callouts may be of two types This methodology is explained thoroughly in Reference 7 OR As was concluded in the Recorder Review Ref 2 1 7 GRAPHICS Figures tables photos and charts are all considered graphics Figures photos and charts will be assigned figure num
13. early 1970s SDDs For Illustration Only B 2 Company Writer s Guide 3 Abbreviations with periods lower case letters used as nouns and capital letters that would form another word if s alone were added form the plural with an apostrophe and an s Ph D s x s and y s S s A s I s Letter Symbols for Units of Measurement The following pages are taken from Corporate Standards These abbreviations should be the only ones used unless stated otherwise in a project specific document For Illustration Only B 3 Company Writer s Guide Symbols for Units in General Use a a an aean O a pinaragan rroa a 2 oO er ee aag mpi dmg we ANAT 1 atm 101 325 Pa deprecated see ANSI Z210 1 atmosphere standard 1976 atmosphere technical 1 at 1 kgf cm deprecated see ANSI Z210 1 1976 atomic mass unit unified u The unified atomic mass unit is defined as one twelfth of the mass of an atom of the C nuclide Use of the old atomic mass amu defined by reference to oxygen is deprecated as bar 1 bar 100 kPa Use of the bar is strongly discouraged see ANSI Z210 1 1976 except for limited use in meteorology barrel per day bl d This is the standard barrel used for petroleum etc A different standard barrel is used for fruits vegetables and dry commodities baud In telecommunications a unit of signaling speed equal to one element per second The signaling speed in bauds is equal to t
14. ent degree number equal to plus minus less than greater than and the like Symbols should be used in the following cases e For temperatures given with a numerical value use the degree symbol 32 C etc e For equations either written in line with the text or displayed standing alone use symbols e In graphics figures and tables use symbols if space is a problem The use of symbols in text should be avoided in most cases Write out phrases to ensure clarity For example use greater than instead of gt The following generally accepted symbols may be used e Delta A e Degrees Celsius C e Degrees Fahrenheit F I e Plus or minus The following symbols should be avoided but may be used when necessary such as in tables and figures to save space e Equal to e Approximately e Greater than gt e Less than lt e Greater than or equal to 2 e Less than or equal to lt e Inches e Feet e Number e Plus e Minus e And amp For Illustration Only 1 5 Company Writer s Guide 1 3 PUNCTUATION Standard rules of English as defined by Strunk and White for grammar and punctuation should be used Avoid long sentences use semicolons only in short sentences Also avoid using contractions because they often cause confusion Use the final comma in a series e g apples oranges and pears Place periods after the following e Sentences e Between heading digits e g
15. f heat capacity and entropy kelvin K In 1967 the CGPM gave the name kelvin to the SI unit of temperature which had formerly been For Illustration Only B 9 Company Writer s Guide Symbols for Units in General Use Cont d ft called degree kelvin and assigned it the symbol K without the symbol CS fangs ie ow TT gam ie k k k kilogram force Deprecated see ANSI Z210 1 1976 In some countries the name kilopond kp has been used for this unit k k k SI unit of mass G 8 gf C a C S e e e S V A W h Kilopound force should not be misinterpreted as kilopond see kilogram force Also kWeh 1 kn 1 nmi h lambert L 1 L 1 1 cd cm A CGS unit of luminance One lumen per square centimeter leaves a surface whose luminance is one lambert in all directions within a hemisphere Deprecated see ANSI Z210 1 1976 For Illustration Only B 10 Company Writer s Guide Symbols for Units in General Use Cont d liter 1 L 10 m The letter symbol has been adopted for liter by the CGPM and it is recommended in a number of international standards In 1978 the CIPM accepted L as an alternative symbol Because of frequent confusion with the numeral 1 the letter symbol 1 is no longer recommended for USA use see Federal Register notice of December 10 1976 The script letter P which had been proposed is not recommended as a symbol for liter eS e lumen per square foot
16. he reciprocal of the signal element length in seconds For Illustration Only B 4 A A Ah A m atm at aA bar bbl b Company Writer s Guide Symbols for Units in General Use Cont d becquerel Bq SI unit of activity of a radionuclide billion electronvolts The name gigaelectronvolt is preferred for this unit bit In information theory the bit is a unit of information content equal to the information content of a message the a priori probability of which is one half In computer science the bit is a unit of storage capacity The capacity in bits of a storage device is the logarithm to the base two of the number of possible states of the device calorie 1 cal 4 1868 J deprecated see ANSI Z210 1 International Table calorie 1976 calorie 1 cal 4 1840 J deprecated thermochemical calorie see ANSI Z210 1 1976 candela d SI unit of luminous intensity candela per square inch cd in Use of the SI unit cd m is preferred candela per square meter cd m SI unit of luminance The name nit is sometimes used for this unit candle cd The unit of luminous intensity has been given the name candela use of the name candle for this unit is deprecated For Illustration Only B 5 Company Writer s Guide Symbols for Units in General Use Cont d centipoise cP 1cP 1mPaes The name is deprecated see ANSI Z210 1 1976 centistokes cSt 1 cst 1 mm s The name centistokes is deprecated see
17. ly qualified e Phrases and words that obscure the central meaning for example Wrong The system is designed such that active components are capable of being tested during plant operation Right The active components can be tested during plant operation For Illustration Only 1 1 Company Writer s Guide Table 1 1 1 Examples of Wordiness Verbose ese Equivalent consider all factors carefully due to the fact that furthermore it would seem and give proper consideration to in spite of the fact that in this instance however but is capable of has the ability to can situated placed sits lies termination end utilize use warrant the use of must or should have require For Illustration Only 1 2 Company Writer s Guide 3 Make sure that your graphics clearly support information in the text Have you chosen the most illustrative graphics in each section Is there a difficult passage of text that you could elucidate with a figure Verb Tenses As a general rule use the present tense For example our design includes not will include or included our Project Team is ready not will be ready However use future tense when describing project activities still to be performed Also use future tense in outline revisions when describing what completed sections will contain Use past tense when discussing completed project activities observations from walkdowns and the
18. mputer is off line For Illustration Only 1 13 Company Writer s Guide APPENDIX A COMMONLY USED TRADEMARKS The first use of a trademark name should include or as appropriate The following are the most often used trademarks in our business as they should appear under Acronyms and Trademarks in the front matter Adobe and the Adobe logo first if used followed by other Adobe marks used in alphabetical order are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and or other countries Autodesk AutoCAD and Autodesk Inventor are either registered trademarks or trademarks of Autodesk Inc in the USA and or other countries All other brand names product names or trademarks belong to their respective holders Cisco is a registered trademark of Cisco Systems Incorporated DEC is a trademark of Digital Equipment Corporation Diamond Plus is a registered trademark of Mitsubishi Electronics America Incorporated EIMaster Power Concept is a registered of Sigma Power Software AB Energy Star is a U S registered trademark Intel and Pentium are registered trademarks of Intel Corporation LaserJet JetAdmin and HP9000 and other printer models are trademarks of Hewlett Packard Company Microsoft Encarta MSN and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and or other coun
19. ompany Writer s Guide When using unit abbreviations such as Btu kW Hz a space should be placed between the number and the abbreviation e g 100 Btu 3 kW 50 Hz Refrain from using the symbols and for inches and feet unless referring to a plant elevation or when it is necessary to save space i e within tables forms etc However use inches and feet in their proper forms as follows 0 5 inch of space around the margin singular 2 inches in diameter plural a 3 inch circle used as an adjective and therefore hyphenated Below are a few commonly used abbreviations in their proper form Type 316 SS notice the cap T and the space between 316 and SS 2 1 4 Cr 1 Mo E 953011 hyphen after the E Do not abbreviate the company name in text except as part of abbreviations of subsidiary or joint venture names For equipment names used repeatedly in text spell it out the first time with the abbreviation in parentheses following the name Subsequent references can then be made by the abbreviation alone Also note that if a control name printed on the equipment is abbreviated it should be repeated exactly including capitalization when cited in the text Plurals of Abbreviations 1 Abbreviations in units of measure are identical in their singular and plural forms e g 10 Ib not 10 lbs ay Acronyms letters and numbers are made plural by adding s alone the three Rs in twos and threes LPRs the
20. results of studies and tests already performed The controls analysis showed that Active versus Passive Voice Use active voice to raise impact Examples include Passive Procedures were initiated to reduce plant accidents Active The company initiated procedures to reduce plant accidents Passive voice is acceptable and is used often in customer documents in a particular situation when the object in the sentence must have emphasis over the subject Example The Quality Plan must be followed by all subcontractors Additional Guidance 1 Avoid pathetic fallacy that is giving inanimate objects actions or responsibilities Examples include e The Management Plan ensures a plan cannot ensure e The program is enjoying success a program cannot enjoy e The site must consider a site cannot consider 2 The word comprise means to include or to be made up of A large entity cannot be comprised of smaller things It comprises them For Illustration Only 1 3 Company Writer s Guide 3 Be assertive in your writing Examples include Wu e Use will not may plan to or would Use plan only as a noun or in the strict sense of planning and scheduling e Use shall only in discussing project or regulatory requirements e Use ensure not insure Assure is not as forceful as ensure However use assure in quality assurance disc
21. s General guidelines for proper use are the following e Express safety class and quality group in Arabic numerals 1 2 3 e Express seismic category in Roman numerals I II MI e Express electrical Class 1E in Arabic not IE e Express steps in a process in Arabic Use Arabic numerals unless specific nomenclature dictates otherwise and with lower case Roman numerals for table of contents list of figures etc Avoid spelling out large numbers unless nomenclature dictates it Spell out integers less than 10 that do not apply to a specific measurement e g two procedures 2 inches Use commas in four digit or larger numbers except in hexadecimal numbers Be consistent in using units of measure European customers require metric units of measure Preferred presentation of measurements in European projects is metric or SI followed by English in parentheses Normally in text use written out units Exception electrical units V A Hz Abbreviate other units in tables and where space is limited For Illustration Only 1 7 Company Writer s Guide When a spelled out unit of measurement is used with a quantity use the singular or plural form of the unit of measurement based on the following criteria e If the quantity is the unit 1 or a fraction of 1 use the singular form of the spelled out unit of measurement Examples 0 6 meter 1 32inch 1second e Ifthe quantity is zero or more than the
22. tries Motif OSF 1 UNIX and the X device are registered trademarks and Making Standards Work and The Open Group are trademarks of The Open Group in the US and other countries MultiSync and FE are trademarks of NEC Mitsubishi Electronic Display of America Incorporated For Illustration Only A 1 Company Writer s Guide Netscape and the Netscape N and Ship s Wheel logos are registered trademarks of Netscape Communications Corporation in the U S and other countries List other Netscape product names used in your document are also trademarks of Netscape Communications Corporation and may be registered outside the U S Oracle is a registered trademark of Oracle Corporation Primavera Project Planner is a registered trademark of Primavera Systems Incorporated SAP R3 is a trademark of SAP AG Corporation ServSwitch is a trademark of Black Box Corporation SPARC is a registered trademark of SPARC International Incorporated Sun Sun Microsystems Sun Enterprise Ultra UltraSPARC Solstice StorEdge Solaris Java all Sun Solaris Java formative trademarks and logos are trademarks or registered trademarks of Sun Microsystems Incorporated in the United States and other countries For Illustration Only A 2 Company Writer s Guide APPENDIX B ABBREVIATIONS AND SYMBOLS Abbreviations facilitate reading and minimize dull repetition of cumbersome names Abbreviations should be
23. unit 1 use the plural form of the spelled out unit of measurement Examples Oinches 1 6 meters 3 1 2 millimeters 8seconds e Remember however that the singular form of an abbreviated unit of measurement is used also for the plural and modified forms Examples 0VDC 35m 8s interval 1 6 REFERENCES There are many accepted models for writing references each appropriate for a given class of documents from scholarly works to popular periodicals We present a conventional approach that has worked well for most projects Applying these simple rules will help us standardize reference lists 1 The usual sequence for entering a company document in a reference list is document number followed by the title in quotes revision number if applicable then issuing unit and date There are subtle variations depending on the type of document For Illustration Only 1 8 Company Writer s Guide When listing project specific documents follow this example Document number ABC Project XYZ System General Requirements Business Unit date Note It is not necessary to give the revision level of project documents unless there is a specific reason to cite an earlier revision The most recent revision at the time of issuance applies 2 For standards and regulatory guidance the form is number title in quotes revision if applicable issuing body and date if applicable 3 External publishe
24. ussions 4 Avoid a tutorial writing style First one must then one does and after these steps one logically progresses to 5 Be consistent with terminology Use terms as agreed with the customer in commercial agreements and elsewhere Defer to customer terminology not ours 1 2 ABBREVIATIONS ACRONYMS TRADEMARKS AND SYMBOLS Abbreviations acronyms trademarks and symbols should be consistent throughout the deliverables and consistent with generally accepted usage Acronyms should be used sparingly in the text particularly in international projects Acronyms are used in parentheses following the spelled out form in the first reference A team may produce a list of the most common acronyms for their project Appendix A contains the most commonly used trademark references Initial uses of trademarked names appear with or as appropriate Appendix B provides a list of company approved abbreviations and symbols Use only those abbreviations acronyms or symbols that are common in our industry and that are defined a When using a or an before an abbreviation or acronym make sure that the article agrees with ii the initial sound of the term as it is normally pronounced The article a precedes a consonant sound and an precedes a vowel sound For Illustration Only 1 4 Company Writer s Guide In text use the word form of common abbreviations such as perc
Download Pdf Manuals
Related Search