HP (Hewlett-Packard) TextEngineer Technical Writing Guide manual

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-1 SECT ION 1 STYL E G UID E This se ct ion o f the W rit e r’s Guide is in t e n d ed to establis h a bas ic writin g s ty le tha t is clea r, co n cis e, and con s i ste n t in pres entation o f inform at ion . Te ch n ica l in form ation requ ires more string en t st an dardiza tio n t[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-2 Table 1.1-1. Exampl es of Wo rdiness Verbose-ese Equivalent by m eans of by conn ect to g ether conn ect, j oin cons ider all fa ct or s ca re fu lly cons ider due to the fact that because for the purpose of for, to furthermore it would s eem and giv e p r oper cons id e ra t ion to cons[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-3 3. Make sur e t hat your gra phic s cl earl y su ppor t info rmat io n in the text . H ave you chose n t he mo s t illu s t ra t iv e gra p hics in each se ct ion ? Is th ere a difficu lt p ass age o f tex t th at y ou cou ld elucidate w ith a figure? Verb Tenses As a gene ra l rule, us [...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-4 3. Be ass e rtiv e in y our writ in g. Examp le s in clu d e : • Us e “will” n ot “may, ” “plan to, ” or “ wo u ld.” Use “pla n ” on ly as a no un o r in the st rict sense o f plannin g and scheduli ng. • Us e “s hall” o n ly in dis cussing pr oj e ct or regu [...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-5 In t ext , use the wor d f or m of commo n ab b re vi atio ns such as perce nt, d egr ee, numb er, e qual to , plu s, min us , le ss than, gre a t er t han , a n d th e lik e. Sym bols sh ould be us e d in the fo llowin g cas es: • For temperatures given w ith a n um erical value, u se[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-6 1.3 PUNCTUA T ION Standard rules of English (as defi ned by Stru nk and White 1 ) for grammar a nd punctuation sh ould be used . Avoid lo ng se ntences ; use semi col ons (;) o nl y in shor t s enten ce s. A lso , a v o id us ing con t ra ct io n s becau s e th ey of ten caus e confus io[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-7 Ca p it a lize a ll le tt e rs in e ach of the follo win g : • Ma in se ction headin gs • Acron y ms, in it ia lis ms Do n ot cap italize : • Generic product and component name s (for example, controller, pane l, switch) • Ge ner ic sy ste m name s • Acron y m definit io n s ( [...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-8 Wh en a s pelle d-out unit of m easur e ment is us ed with a quantity, us e the singular or plural form of the un it o f mea su re m ent based on t h e followin g criteria : • If the quantity is the unit 1 or a f raction of 1, use t he singular form of th e spelled-out unit of measurem[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-9 Whe n listing pro j e ct -sp e cific d ocu men t s, follow this e x am p le. Document number, AB C Project, “XYZ Sy s t em General Req uirements,” Bu siness Unit, date . Note It i s not nec essa r y to give the revi sion l evel of proj ect do cu ment s unles s t here is a specific re[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-10 5. The ordering of docu m en ts in the reference list should correspond to the sequence of references used in the doc ument, s o that Reference 1 i s the first o ne used , 2 th e second, and so o n . 6. Reference call outs may be of two types. “This methodolog y is explained t horough[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-11 AC air flow Alloy 750 aroun d -th e -clock (u m) ASME Co de B.S., M .S. back fit back flow back lit back pres sure back up be st-est ima te ( um) boil-o ff (n , um) break-even (u m) Btu buildu p built-in (um ) bu ses byp ass ca rbo n ste el ( n , um) centerline cha nge out clos e-up clo[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-12 hard-cop y (um ) hard-fa ce (u m ) hard rock (um) hard-w ired heatup (u m ) hig h -bu ild (u m ) high- ener gy ( um) high-level (um) hol d-d ow n (um) hol dup hot-d ip ( u m) hu m an-fact or (u m ) in-dep t h (um ) in-flow (u m ) in-hou se (um) in- leaka ge (u m) in-s e rv ice (u m ) in[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] 1-13 post- heat post- tes t preheat preo perati ona l pre-procurement pre-service (um) proa c ti ve pushbutton read-ou t (n , um) real-tim e (u m ) record-keep ing (um) remot e-h a n dled (um) roundtable se lf-s u fficient (u m) set point shea r w ave (um) shutd own sig n -off (n, um) so cio[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] A-1 APPE NDIX A COMMONL Y U SED TRAD E MARKS The first use of a tradem ark name should include “® ” or “™” as a p p ropriate. The follow ing are the most often-u s ed trademarks in our bus iness a s they s h ould ap pear under “ Acronyms and Trademarks” in the front matter . [[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] A-2 Netscape and the Net scape N a nd Ship's W heel lo g os are registered trademar ks of Net scape Co mm u n ication s C orporat io n in th e U. S. and other cou n t rie s. [Lis t o the r Ne tsca p e p ro du ct na me s used in your document] are also trade marks of Ne ts cape Communic [...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-1 APPE NDIX B AB BR EVIA TI ONS AND SYMBOLS Abbrev ia tio n s facilitat e rea din g an d min i mize du ll repe t it ion o f cum bers ome n ames. Abbrev ia t ion s sh o u ld be us e d on ly wh e n ne cess ary an d when t heir m eanings are unqu es t ion ably clear. W hen in dou bt, sp ell i[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-2 4. Wh en usin g uni t ab br evia tion s su ch a s Bt u, kW, Hz . . . a spac e sho uld be plac ed be twee n the number and the abb reviation. e.g.; 100 Btu , 3 kW, 50 Hz . 5. Re fra in from us ing th e sym bo ls " and ' for inch es an d fe et un less ref err i ng to a p lan t el[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-3 3. Abb reviations wi th periods, l ower-c ase letters use d as nou n s, and ca p ital letters that would form another wo rd if “ s ” alone were add ed form t he plural w ith an apostrophe a nd an “s” : Ph .D.’ s x’s a nd y’s S’s, A’ s, I’s Letter Sy mbols for Units of[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-4 Sym bo ls for Units in Ge ner a l Use Unit Sy mbol Notes ampe re A SI u nit o f el ec tric cur re nt. ampe re (turn) A SI unit of magnetomotive forc e. ampe re-hour Ah Also A•h amper e per meter A/m SI u nit o f magne ti c fi el d stren gth . angstrom Δ 1 Δ = 1 0 -10 m (deprecated, s[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-5 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes bel B becqu e re l Bq SI un it of a ctiv ity of a radio n u clide . billio n e lect ro n v olt s GeV The name giga electro nvolt is preferred for this unit. bit b In in formation theory, the bit is a un it of inform ation[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-6 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes cent ipois e cP 1 c P = 1 m Pa • s. The name i s deprecated (see ANSI Z210.1-1976). cent isto kes cSt 1 cst = 1 mm 2 /s . Th e name centi stoke s i s deprecated (see ANS I Z210.1-1976). circular m il cmil 1 cm il = ( Π[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-7 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes darcy D 1 D = 1 c P (cm/s) ( cm/atm) = 0. 986 923 μ m 2 A unit of perm eability of a porous med ium . By trad itio n a l de fin it ion , a perme a bilit y o f one darcy will p e rm it a flow of 1 cm 3 /s of fluid of 1 cP[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-8 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes exa E SI prefi x for 10 16 . fara d F SI unit o f ca pa cit a n ce . fem t o f SI prefix for 1 0 -15 . femtometer fm foot ft conventional foot of water ftH 2 O 1 ftH 2 O = 2989 . 1 Pa (I SO) foot per minute ft/min foot pe[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-9 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes giga el ectr onv ol t GeV gigahertz GHz gilbe rt Gb The gilbert is the electromagnetic CGS unit of magnetomotive forc e. De precated (see ANSI Z 210.1-1976). grai n gr gram g gr am p er cubic cent im eter g/cm 3 gray Gy S[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-10 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes called degree kelv in and assigned i t t he symbol K (witho u t t h e sym bol ° ). kilo k SI prefix for 10 3 . kilogauss kG Deprecated (see ANSI Z210.1-1976). kil ogram kg S I uni t o f mass . kil ogram- forc e kgf Depr[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-11 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes liter L 1 L = 10 -3 m 3 . T he letter symbol l h a s been adopted for lit er b y the CGPM , and it is recom m e n de d in a number of inte rn at ion al standards. I n 1978, th e CIPM acc epted L as an alternative symbol.[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-12 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes metric ton t 1 t = 1 ,000 kg. The na me tonne is us e d in some coun tries fo r this un it , bu t use o f this n am e in th e USA is deprec ated (see ANS I Z210.1-1976) . mho mho Form erly used as t he name of the s ieme[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-13 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes millilit er mL See not e for l iter . millim eter m m conv e n t ion al millim eter of merc ury mmHg 1 mmHg = 133.322 Pa (deprecated, see ANSI Z210 .1-1976). millim icron nm U s e o f t h e n am e mill imi cron for the n[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-14 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes newton p er squa re meter N/m 2 SI u nit o f pres sure or str es s, se e pasc al. nit nt 1 nt = 1 cd/m 2 The name nit i s sometimes given to the SI unit of lumi nanc e, the cande l a per square meter. oersted Oe The oers[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-15 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes pou n d-force foot lbf-ft pou n d-force p er squ are foot lbf/ft 2 pou nd-force p e r squa re inch lbf/in 2 Although us e of the abbreviati on psi i s c ommon, it sho uld no t be u sed as a symb ol. pounda l pd l quart q[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-16 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes sq u are foot ft 2 sq u a re inch in 2 squ are meter m 2 squ are meter per s econ d m 2 /s SI unit of kinematic viscosity. sq uare m illimete r per s econd mm 2 /s SI unit-multiple of kinematic viscosity. sq ua re yard y[...]

Company Wr iter' s Gui de [For Illustr atio n Only ] B-17 Sym bols for Units in Gener a l U se (Cont’d) Unit Sy mbol Notes voltampere VA IEC name a nd sy mbol for the SI unit of a ppare nt pow er. watt W SI un it o f power. watt per meter k elvin W/(m • K ) SI u nit o f t her mal c ond ucti vity. watt p e r ste ra dia n W/s r SI unit of ra[...]