TechProse je tehničko pisanje

7/22/2019 TechProse je tehničko pisanje

http://slidepdf.com/reader/full/techprose-je-tehnicko-pisanje 1/45

TechProse je tehničko pisanje , obuku , savjetovanje i informacijske tehnologijeTvrtka posluje od 1982 . Ovaj priručnik pruža tehničku pisanja smjernice ipostavlja standarde za izradu logičke i profesionalno pisani materijal . Ovaj priručnik jevlasničke . TechProse ga daje za osoblje pisaca , savjetnicima i studentima kojistudiraju

Tehnički Pisanje s članom TechProse osoblja .Ovaj priručnik opisuje proces pisanja dobru dokumentaciju . To je osmišljen kako bi sečitati od početka do kraja , kao i da će se koristiti kao vodič za odnose natrag u jednomMaterijal je poznato . TechProse osoblje slijediti te smjernice u izradi svih dokumenata .Neki od materijala u ovom priručniku temelje se na probleme koji, čini se javljaju zavišestrukiProjekti . Na primjer , mnogi pisci pronaćipoteškoće u pisanju izvješća je znatigdje početi . Informacije u " Početak" poglavlju je osmišljen kako bi vam pomoćiodrediti svrhu , korištenje i publiku vašeg dokumenta kako bi olakšali početak .Menadžeri izrazio zabrinutost da izvješća često nisu logično organizirani , a toiste greške se pojavljuju više i više . Za ovaj pravni lijek, u poglavljima " Dopisivanje &

Memorandumi "i" Izvještaji i studije " opisuje kako organizirati dokumente i stavitizadatke u perspektivu. Osim toga ,poglavlje " Style & Običaj " može vam pomoći daizbjegneteuobičajene pogreške koje kuge pisce .Ostali problemi su da svi zaposlenici ima dobru prosudbu i etičkim standardima .U poglavlju " Vaša uloga kao pisac " bavi profesionalno i etično ponašanje pripisanje dokumentacije .U ovom priručniku , mi smo koristili podebljana slova ukazuju na ključne pojmove . Osimtoga ,Svako poglavlje ima popis na kraju da se fokusira na određene točke u tom poglavlju .Popisi provjere osigurati brzi pregled kako bi bili sigurni da su autori izvode temeljna

provjera kvaliteta nacrta materijala prije njihovog slanja na pregled . Dodatak Bdaje sastavljenu popis koji pokriva sve točke . Možete koristiti popis za obavljanjekritički osvrt na svojim prvim nacrtima dokumenata , ili dostaviti popunjeni popisuzprijedlog da bilo tko traži da obavljaju pregled .Organizacija treba održati dosljednost u izgled i dojam svega toganosi svoje ime . Ovaj priručnik je jedan element u nastojanju da uspostavi iodržavavisokustandard kvalitete za sve TechProse materijala . To je dizajniran tako da osoblje moženastavitito s vremenom poboljšati .Naime izostavljeni iz ovog priručnika su smjernice o razvoju kompletna tehničkavodiča , kao što su softver korisnika ili razvojnog priručnika , izradi raznih priručnika , ilitutoriala .Upućujemo u odvojenom priručniku .

Pregled sadržajaUvod u tehničkom pisanju

jaOtk 2,00 , 1. rujna 2004



Pregled sadržajaPoglavlje 1 . Početak ................................................ ................................ 1-11,1 odrediti svrhu i koristiti ............................................ ..... 1-11.2 Prepoznajte publiku i što trebaju .............................. 1-21.3 Odrediti razinu detaljnosti ............................................ ........ 1-2

1.4 organiziranje podataka .............................................. ......................... 1-31.5 Kada radite s tim ........................................... ........ 1-31.6 Rokovi ................................................ .................................... 1-41.7 Sažetak ................................................ .................................... 1-4Podsjetnik - 1 Početak rada ............................................. ............... 1-5Primjeri namjeni i publike Definicija ................................ 1-6Poglavlje 2 . Vaša uloga kao pisac ............................................. ....................... 2:12.1 Zaposliti etičkih načela .............................................. ............ 2:12.2 dati kredit gdje je zbog ............................................. .................. 2:22.3 Sažetak ................................................ .................................... 2:2Podsjetnik 2 - Etika .............................................. ............................ 2-3

Poglavlje 3 . Style & Običaj ............................................... ................................... 3:13.1 Elementi stila .............................................. ......................... 3:13.1.1 prezent , aktiv .......................................... ... 3:13.1.2 jednostavnih rečenica ............................................. ................. 3-23.1.3 Spol Neutralnost ............................................. ................ 3-23.1.4 Kratice i akronimi ........................................... 3-23.1.5 Popis .............................................. ..................................... 3-33.1.6 Naznake .............................................. ............................... 3-33.1.7 Slike i tablice ............................................ ................ 3-33.1.8 cross- reference ............................................ .................... 3-43.1.9 Fusnote i Bilješke ............................................ ........ 3:43.1.10 otpremnina .............................................. ....................... 3-43.1.11 Final Uredi ............................................. ............................ 3-53.2 Wasted riječi i fraze kako bi izbjegli ......................................... 3-5Pregled sadržajaOtk 2,00 , 1. rujna 2004iiUvod u tehničkom pisanju3.3 AZ Reference ............................................... ............................. 3-73.4 Sažetak ................................................ .................................. 3-10Podsjetnik 3 - uređivanje .............................................. ........................ 3-11Uzorak pregled znak - off Obrazac ............................................ ........... 3-124. poglavlje . Korespondencija i memorandumi ............................................... .... 4:14.1 Dopisivanje ................................................ .......................... 4-14.1.1 Držite Komentari unutar obuhvataOrganizacija Odgovornost ..................................... 4:14.1.2 eliminirati osobna mišljenja ............................................ 4:24.1.3 Korištenje odgovarajućem formatu ............................................ ................ 4-24.2 Email ................................................ .......................................... 4-24.2.1 DržavnaTvrtka Jasno ........................................... ........ 4-3



4.2.2 Napišite kratak, čitljiva komunikacije ........................... 4-34.2.3 Zaposliti e-mail Bonton ............................................ ........ 4-34.3 dnevnog reda sastanaka i konferencijske Minutes .................................... 4:44.3.1 dnevnog reda sastanaka ............................................. ................. 4-44.3.2 Sastanak Zapisnik ............................................. .................. 4-5

4.4 memorandumi ................................................ ................................ 4-64.4.1 Tehnički dopisa ............................................. ................. 4-64.4.2 dokumentiranje dopisa ............................................. ........... 4-74.5 Sažetak ................................................ .................................... 4-8Podsjetnik 4 - Korespondencija i memorandumi ................................ 4-9Uzorci i predlošci ............................................... ................... 4-10Uzorak Pismo ................................................ ........................... 4-11Uzorak Tehnička Memo ............................................... ........... 4-13Uzorak Dokumentiranje Memo ............................................... ..... 4-16Tehnički memorandum o predlošku .......................................... 4-17Dokumentiranje Memorandum predloška .................................... 4-18

Poglavlje 5 . Izvještaji i studije ............................................... ............................ 5-15.1 Izvješće Smjernice ............................................... ........................ 5-15.1.1 Sažetak -samostalan poglavlje ................ 5-15.1.2 Sažetak stavci ............................................. ........... 5-25.1.3 Glavni tijelu izvješće .......................................... ........ 5-35.1.4 Zaključci .............................................. ......................... 5-45.1.5 Preporuke .............................................. ............... 5-55.1.6 Prilozi .............................................. .......................... 5-6Pregled sadržajaUvod u tehničkom pisanjuiiiOtk 2,00 , 1. rujna 20045.1.7 Naslovi .............................................. ............................. 5-75.1.8 Referentni informacije ............................................. ......... 5-75.2 Sažetak ................................................ ...................................... 5-7Podsjetnik 5 - Izvješća i studije ............................................ ............. 5-8Dodatak A. Rječnik .............................................. ........................................ A- 1Dodatak B. Dokument Kontrolni popis ............................................. ....................... B - 1Dodatak C. Preporučena Resources ............................................. ..................... C - 1bibliografija

PočetakUvod u tehničkom pisanju 1-1Otk 2,00 , 1. rujna 20041 . PočetakPisanje i zahtijeva više od dobre gramatike . Da biste stvorili koristan dokument , trebateizraziti svrha dokumenta i identificirati publiku za to .Ovo poglavlje je osmišljen kako bi vam pomoći planirati i dovršiti pisanje projekata kao

jednostavan kaopodsjetnik ili kao kompleks kao softver priručniku . Obuhvaća kako :



definirati svrhu tog dokumenta i ključne informacije treba prenijeti

Definiranje publiku i njihovu razinu tehničkog razumijevanja

odrediti razinu pojedinosti potrebne za dokument

Organizirajte podatke

Rad s timom autora

rokova

Ona pruža popis i primjere u posljednjim stranicama poglavlju .1,1 odrediti svrhu i koristitiUspostavljanje svrha dokumenta jeprvi korak u stvaranju bilo koji pisani materijal .Odredite što želite čitatelji znati ili učiniti kada završitečitanju . To se često naziva zadatak analiza .Budite specifični sa svojim ciljevima . Zapitajte se : " Zaštočitatelj treba mi ovoInformacije , i što im je potrebno učiniti s njom ? " Odgovor na ovo pitanje općenitodaje detaljan cilj koji činidokument smisla . Primjerice ,Cilj " za opisivanje tečaj poboljšanja " je preopćenit . Cilj " kako bi opisaonačine kako bikurikulum Tehničke komunikacija 1 vredniji novak

tehnički pisac "jespecifičan cilj koji pomaže definirati potrebne informacije .Pisanje cilj upravo , u smislu onoga što i zašto , pomaže organizirati materijal . kaotest hoće li adekvatno formulirali svoj cilj , pokušati to napravitimjerljivi . Na primjer : " Ovaj dokument pruža informacije potrebne za toPublika napraviti odgovarajuće odluke o specifičnim temama naravno , vježbe, ireferentnihmaterijala ".Jednom definirani ,objektivno vodi svaki korak u procesu prikupljanja i organiziranjaInformacije , pisanje , sumirajući , kao i dovršetak dokument . Pogledajte kako toodrediti što uključuje i što izostaviti . Testirajte dokument u odnosu na objektivnukako bi se osiguralo svaki dio podupire opće svrhe .

1.2 Prepoznajte publiku i što trebajuKljuč dobrog pisanja je razumijevanje publike . Dokument mora biti usmjerenana određene čitatelje , i uzeti u obzir njihovu razinu tehničkog znanja ,Iznos detalje žele , a njihova razina interesa za tu temu . To je čestopozvao korisnik ili analiza potreba . Dizajn dokument kako bi se zadovoljile potrebenjegove specifičnečitatelji u svezi s predmetom , vokabular, razina detalja , i stil pisanja. uOpćenito, pretpostavimo da je publika manje upoznati s predmetom nego što si .Na primjer , ako jedokument treba čitati samo inženjeri , koristite odgovarajućeznanstvenovokabular i detaljne podatke za podršku . Ako jealat za izvršne odluke , predstavitiPodaci u ležao uvjete , s jasnim pratećim slikama .Neki dokumenti su dizajnirani za više publike . U ovom slučaju , odjeljkeusredotočiti na jednu vrstu publike . Na primjer , napisati preporuke , izvršnesažetke, i sažeci za one koji trebaju razumjeti opće implikacijeProjekt . Ciljane prilozi sadrže tablice, grafikone, i sirovi podaci stručnjacima koji želeispitati ili korištenje takvih podataka podržavaju . Možete uključiti pojmovnik dapomogne čitateljima



upoznati posebne terminologije .To može pomoći da napravite popis članova publike i koje informaciješto im je potrebno . Za rad na javnim vodovodom , primjerice ,publika obično uključujebilo koji ili sve od sljedećeg :Javne potrebe biti obaviješteni razumjeti prednosti i mane i utjecaje

i iznosi donositi odluke o inicijativama i drugim političkim pitanjimaOpćina odbor treba razumjeti učinke i troškove , rasporedi, efekti, dugoročnihobveze i politiku.Općina Uprava treba razumjeti troškove , rasporedi, efekata i dugoročneobveze kao osnova za donošenje odluka intermediateProjektni tim treba razumjeti znanstvenu detalj , podržava podataka , funkcije,ograničenja, razmišljanja, i osjetljivih pitanjaOdržavanje iOperacijeTreba razumjeti dizajn funkcije , pristup, operacija, asmjernice za održavanje

Regulatorna agencija treba razumjeti nadležnosti granice , djelovanja i ublažavanjeTe skupine čine mnoge čitatelje . Ona pomaže pisati za jednog, tipičan članskupinu. Popis karakteristika (iskustvo , obuka, obrazovanje , itd. ) te čitatelj možeTakođer bi se utvrdilo kako prezentirati podatke .1.3 Odrediti razinu detaljnostiCilj iciljana publika također diktirati razinu detalja potrebna . ovodefinira opseg dokumenta , ono prateće informacije da su , što se istraživanja

je potrebno , i što predmet stručnjaka mora doprinijeti .

Određivanje što izostaviti je važno kao i ono što odluči uključiti . položitičitatelji ne bi trebali biti osvaja po detaljnim rezultatima istraživanja , već to treba biti

jasno naveo i sažeti . Uključite grafikona ako oni podržavaju ciljeve .

Iako ste možda dobile puno korisnih podataka u pripremi za pisanjeDokument , bacite podaci koji se ne odnose izravno na publiku i namjenidokument .1,4 organizirati podatkeDalje, organizirati podatke kako bi podržala cilj i publiku . To jedobra ideja zasvaki dokument kako bi se osiguralo da pokrivaju sve bitne točke , aliključan korak zanajsloženiji . Izraditi pregled s popisom tema za pokrivanje , publiku za totopic , ključne točke za temu , kao i podaci potrebni za podršku ove točke .Uvjerite se da su podaci u dokumentu izravno podržava logički tijekInformacije . To bi trebao povećati ključne točke u dokumentu , a ne ih pobijediti . stavitipopratni podaci, uključujući i osnovne informacije , složene tablice ili rezultati studije , u

slijepo crijevo . Drugi izvor materijala koji je dostupan čitateljima može se upućuje, aliNe bi trebao biti uključen u samom dokumentu . Poglavlja 3. i 5. ove točke raspraviti upojedinosti .Za složenog dokumenta s više autora , utvrditi tko je odgovoran za svakoOsobito u području sadržaja . Koristite obris procijeniti vrijeme potrebno za prikupljanjepodataka ,pisanje , uređivanje i objavljivanje dokumenta , kao i za procjenu potencijalneprobleme . obris



jekoristan alat za strategizing kako otkloniti probleme prije nego se pojave .1.5 Kada radite s timKadje dokumentzajednički rad , prva identifikaciju primarnih suradnike i njihove uloge .Zatim , neka svaki član tima zna razinu detalja potrebnih , publika , irokovi . Osigurati Svaki sudionik obris cijelog dokumenta , tako da je

svi znaju kako njihov odjel uklapa u cjelinu . Koristite ovaj vodič kao pisaćiprimjer onoga što očekivati u smislu stil pisanja . Dodatakza topriručnik djeluje kao rudimentaran stil vodič koji navodi ključni pojmovi i standardniakronime . Možete dodati na ovo s uvjetima ili konvencijama primjerenim zaspecifičnedokument .Jeste svaki suradnik obvezati na popunjavanju nacrt materijala unutaročekivanogvremenski okvir . Budući članovi tima često imaju i druge obveze i zauzet rasporedi,slijedite gore sa svakog autora kako bi se osiguralo da je obaveza se sastao i je li biloPojavili su se problemi .Za dokumenata s više autora ,urednika projekt može uvelike poboljšatikonačniproizvoda. Urednica je uloga je osigurati jednu suvislu , stil pisanja , eliminirati

viškovi ili kontradikcije , i održati korištenje terminologije

1.6. Rokovi

Počevši s crtama, rokovi moraju biti jasni, a članovi tima trebajuobvezati na njih u pismenom obliku. Upravljanje razvoj složenog dokumentaupravljanje projektima zadatak koji zahtijeva česte kontakte sa svim suradnicima. JedanpropustiliRok može izazvati lavinu propustili rokove. Dakle, važno je da sesvjesni potencijalnih problema prije nego se pojave. Ako je moguće, to je uvijek najboljeda plan za

Neki manevarskog prostora u rasporedu, tako da kasni doprinosa ne utječe na kvalitetuProjekt.Sjeti se kako bi se omogućilo dovoljno vremena za realizaciju projekta urednika, kao iza proizvodnju.Kao opće pravilo, iskusni urednik može copyedit oko pet stranicevrlo tehnički podaci sat vremena, do deset stranicama dobro napisana generičkihinformacija.

Alati kao što su Microsoft Project su korisne za praćenje napretka, ali nemazamjena za ruke-na upravljanje, uključujući i česte komunikacije sa svim timČlanovi.1.7 Sažetak

Ključ za stvaranje smislene dokument je razumijevanje i svrhu uDokument služi i publiku koja će ga čitati. S potpunom razumijevanjuta dva načela, potrebna razina detalja postaje jasan. Zatim, razvijajupregled onoga što bi dokument trebao uključivati. Iz jednostavnog dopisu, to može biti

jedan ili dvaključne točke usmjeren na ciljanu publiku. Za složene dokumente s višesuradnika, što uključuje i tema obrise, rokove i pojedinačne odgovornosti za svakudio dokumenta.Urednik projekt može uvelike poboljšati kontinuitet i



čitljivost dokumenata s više autora.Proces razvoja kompleksudokument za upravljanje zadatak koji zahtijeva da jasna očekivanja, obvezei tijeku komunikacije. Plan za svaki korak, i ostaviti vremena za uređivanje iproizvodnja. U svim slučajevima, testiranje završnog dokumenta u odnosu na izvornusvrhu i

zahtjevi prepoznaje publike.

2 . Vaša uloga kao pisacTehničko pisanje zahtijeva objektivnu analizu i jasnu prezentaciju . Što godtopic , to je imperativ da djeluje profesionalno i etički u svim poslovima s vašimodređenu publiku , javne i državne agencije . Jer ono što pišeš je običnoraditi za najam , bilo za tvrtke ili državne ustanove , važno je ostati unutar smjernice za financiranje organizacije u pisanom obliku . Napišite s mišljenjemPredstavnik tog entiteta .Kadvam odgovoriti u pisanom obliku kolegama , klijentima , upravljanje , ilijavna ,dopisivanje postaje dio organizacijski ili javni zapis , tako da je važno dapisana komunikacija je jasan i precizan .Provjerite svoje e-mailove i pisma izraziti svoje ili svoje tvrtke poziciju bezkritizira ili vrijeđa primatelja . Dopisivanje treba ostati unutar Granica u temu ,područje tražene poruci , a tvrtka je politika .2.1 zaposliti etičkih načelaPriručnik za tehničke Pisanje navodi pet etička načela pridržavati prilikomwriting1 :

Izbjegavajte jezik koji pokušava izbjeći odgovornost .

Izbjegavajte jezik to uopće moglo dovesti u zabludu čitatelje .

Ne de - naglasiti ili potiskuju važne informacije .

Ne naglašavaju pogrešne ili netočne informacije .

prema drugima pravedno is poštovanjem .

ObaNational Society of Professional inženjera iAmerican Society of CivilInženjeri su kodekse ponašanja . Jedan od tih smjernica koje se odnose na tehničkepisanja

je kako slijedi :Inženjeri moraju biti objektivni i iskreni u stručnim izvješćima , izjavama , ili

svjedočenja . Oni će uključiti sve relevantne i važne informacije u takvim izvješćima ,izvještaji ili svjedočenja.Točnost tehničkih podataka jeodgovornost pisca . Provjerite imate liInformacije morate napisati točna izvješća i postupke .1. Za informacije o Priručnik za tehničke pisanja , vidjeti Bibliografija .Vaša uloga kao pisacOtk 2,00 , 1. rujna 20042:2Uvod u tehničkom pisanju2.2 dati kredit Gdje ZbogTo je neetično koristiti informacije ili ideje koje nisu sami, bez pokrićaih . Podaci dobiveni iz istraživanja kolega je jednako važno kao iInformacije koje ste pronašli u tiskanoj knjizi . Uvjerite se dodati fusnotu davanje



Kolega iliknjiga kredit . Microsoft Word ima mogućnost Insert Fusnota za dodavanjefusnote .Kompletna dokumentacija i dosljedna svojih izvora informacija možete:

Pomoć vaši čitatelji pronaći informacije i ne slijedite - up istraživanja

Pomoć Podržavate li svoj položaj , preporuka ili zaključke

pomoći da izbjegnete plagijat

Koristite fusnote , Bilješke i bibliografije priznati gdje se nalaze određene bitovaInformacije . Na primjer , u mnogim izvještajima ,pozadinska poglavlje govori o povijestitog projekta , aline spominje gdje jeinformacija došla. U nekim slučajevima ,proizlazi iz podatakadrugo izvješće ili dokument unutar iste organizacije . To nije plagijat koristiti nešto od

još je jedan dokument u drugom dokumentu pisanom za iste organizacije , ali to nepomažeČitatelj pronaći više informacija . Ako ste citirajući znatnu količinu materijala , potrebno

je pribavitiispišite dopuštenje izdavača . Ako ste parafraziranje , jednostavno kreditneizvor . To se

neSamo priznaje suradnik , ali i daje vjerodostojnost vaše prezentacije .2.3 SažetakZa sve tehničke pisanja , profesionalno ponašanje i visokih etičkih standarda su važnizaodržavanju vjerodostojnost . Iako je ponekad teško , vaša odgovornost kao pisac

je ostati neutralan i objektivan kad god je moguće . Ostanite u okviru projektai izbjeći navodeći osobna mišljenja ili izradu predrasudama izjave u tvrtki ili javnomdokumentima. Sljedeći popis daje niz pitanja za pregled kao diodeveloping pisane komunikacije . Njihova funkcija je osigurati da informacijeprimjereno iu skladu s korporativne i državne očekivanja .Podsjetnik 2 - etikaUvod u tehničkom pisanju 2-3Otk 2,00 , 1. rujna 2004Podsjetnik 2 - etika

Jezik jasno kaže tko je za što odgovoran .

Ispravno predstavlja sve podatke

Oštre jezik to uopće moglo dovesti u zabludu čitatelje .

Pruža ispravan naglasak na temelju podataka .

Tretira stavove drugih pošteno i profesionalno .

jasno navodi sve izvore koji se koriste za pisanje izvješća .

Svaka alternativa je predstavljen na jasan i nepristran način .

Sve preporuke i zaključci su podržani od strane činjenica koje su iznesene u izvješću .

Svi sudovi , preporuke, ili komentari su u okviru projekta ili

postupke organizacije politike .priznali i dobili dozvolu za korištenje autorskim pravima informacije koristiti u

prijaviti .Sav materijal je bitno za ovaj projekt .

Dokument se provjerava za komentare koji bi mogli biti pogrešno shvaćena ili izazvati

sukob u



financiranja organizacija .

Style & ObičajUvod u tehničkom pisanju 3-1Otk 2,00 , 1. rujna 2004

3 . Style & ObičajOvo poglavlje donosi neka osnovna pravila dobrog poslovnog pisanja . To govori osastojci dobro stil pisanja , i pokazuje uobičajene pogreške i ponudepoboljšanih primjeri . Poglavlje uključujesljedeće :

Zajednički elementi dobrog pisanja

fraze kako bi se izbjeglo

kratka, abecedni popis često pogrešno korištene riječi i fraze , i primjere

ispravna upotrebaUređivanje popis pojavi na posljednjoj stranici .3.1 Elementi stilaPoznati pisanje priručnika , Elementi stila , prema Strunk i bijela omogućuje

definitivni pozivanje na pravila dobrog pisanja . Ostali važni tekstovi koji se odnose naza stili podatke o upotrebi suChicago Manual of Style iPriručnik tehničkihPisanje . Ovaj dio ne može pokriti sve teme u ovim izvrsnim referencama . Umjestotoga,predstavlja neke važne pravila za dobar osnovnu komunikaciju .3.1.1 prezent , aktivMožda ste primijetili da se u ovom priručniku većina rečenice su u sadašnjem vremenu .mine kažem da će to učiniti , a , što ste to učinili . Koristite " oporuka " i " shalls " kadaželiteoznačavaju nešto u budućnosti , inače , koristite sadašnje vrijeme . Na primjer :Umjesto "materijal o poslovnoj primjeni će pokazati ... "Koristite "materijal o poslovnoj primjeni pokazuje ... "Umjesto " Nakon čitanja ovog materijala ,odbor će odrediti prikladnoakcije ... "Koristite " Nakon čitanja tog materijala ,odbor može odrediti odgovarajuće postupke ... "Osim toga , smanjiti korištenje gerunds ( glagoli na " ing " ) . To znaju biti nejasne .Umjesto "Zastupnik traži državnu pomoć kada je dostupan . "Koristite " Zahtjev za pomoć kad je raspoloživ državni . " To jasno pokazuje da je toOdgovornost ove publike kako bi zahtjev .Prezent daje energiju pisanja . Na isti način , aktivan glas je izravna ipokazuje tko je odgovoran za djelovanje . Aktivno glas poprima oblik "neB " ; trpno poprima oblik " B je učinjeno " Aktivno glas izbjegava nejasnoća .svojstvena pasivu . Pasivu odvodi od koji obavljaodređeneStyle & ObičajOtk 2,00 , 1. rujna 20043-2Uvod u tehničkom pisanjuaction . Fraze poput " Predviđa se da ... " ili " okolnosti nalažu " supodrazumijevani



pasivne gradnje . Izbjegavajte ove izraze .U nekim slučajevima , pasivni glas je prihvatljiva . Na primjer , u opširnom izvješćuopisujegrađevinska aktivnost ,čitatelj ne može znati točno tko je kopanje ilibušenje . U tim slučajevima ,frazu kao što su " na terenu će biti iskopano " je prihvatljivo

.Međutim , općenito , pasivna gradnja čini nespretnom proze . Na primjer :Umjesto " Utvrđeno je da je potrebna hitna akcija . "Koristite "Odbor zatražio hitnu akciju . "3.1.2 jednostavnih rečenicaOsim jasno poručuje tko što radi , aktivan glas pomaže vam napisati jednostavan,deklaratitvno kazne . Možete poboljšati mnoge komplicirane rečenice cijepanjemih u dvije jednostavnije rečenice , svaki izražavajući jasnu ideju . Pročitajte dokumenti vidjeti da li se može razjasniti informacije koje razbijanja savijen rečenice .Umjesto " generirati realan i pravovremene procjene troškova kako bi se smanjilismetnje

građevinskih aktivnosti , jer je dostupnost financiranje može bitiograničavajući faktor . "Koristite "razvijanje realne procjene troškova izgradnje i rokove na početkusvaka djelatnost . Sredstva za prekoračenja možda neće biti dostupne . "3.1.3 Spol NeutralnostNe osobna zamjenica u engleskom odnosi na oba spola . On / ona alternativa jenespretno .Kad se govori o opće kategorije ljudi , pokušati prepisati rečenicu u množiniizbjeći pitanje spola . Na primjer :Umjesto "programer bi vidjeli propust u tom logikom . Bio bi to ispravitiodmah . "Koristite " Programeri će vidjeti propust u tom logikom . Oni će to ispravitiodmah . "Koristite rodno neutralan imenice i zamjenice , kao što su stolice , umjestopredsjednika , i njihov ,oni , ili ih umjesto on , ona , nju, ili njega .3.1.4 Kratice i akronimiPrvi put kada koristite kraticu ili kraticu u dokumentu , to spell out , čak i ako jemislite da je vaš publika poznaje pojam . Odgovarajućem formatu je sricati riječ punuili fraza , slijedi skraćenica u zagradi . Na primjer : Massachusetts BayTransit Authority ( MBTA ) . Nakon toga , to je pravilno koristiti samo kraticuu cijelom dokumentu . Međutim , ako dijelovi dokumenta su dizajnirani da stojeSamo , redefinirati Pojam prvi put kada ga koristiti u odjeljku . To je uvijek korisnouključuju pojmovnik ako vaš dokument sadrži mnoge akronima uProjekt - posebni uvjeti . Vidi Prilog za primjer pojmovnik .Style & ObičajUvod u tehničkom pisanju 3-3Otk 2,00 , 1. rujna 2004Naznake sunaviknutsažeti ili



skrenuti pozornostnaspecifičantočka u tekstu .3.1.5 PopisiPopisi mogu uštedjeti čitateljima vrijeme, omogućujući im da vide određene stavke ,

pitanja ilismjerovi na prvi pogled. Oni također omogućuju ključne ideje da se ističu iz okolnogteksta .Popise s grafičkim oznakama predstaviti niz stavki kao što su . Brojčane popisioznačavaju predmete ili sekvencijalnepredmeti rangirani po važnosti . Brojevi također pomoći čitateljima odnose na pojedinestavke , asu stoga korisno kada želite predstaviti strategije ili izbora koji čitatelji mogu želerazgovarati .Proizvodi u svim popisima treba imati paralelnu strukturu . Nemojte miješati stavke kojesu radnje i

početi s glagolom sa stavkama koje su rezultati i početi s imenicom . Ako jedna stavkapopisa jepotpune rečenice , sve bi trebalo biti . Isto tako , svi predmeti trebaju biti izrazi ako jenetkoFraza . Rečenice trebaju imati razdoblja na kraju ; fraza ne bi trebali. Akopopis imaviše razina , svaka razina mora sadržavati stavke koje su podjednako u funkciji . Kaduvlačenjeu popisu , svaki stupanj bi trebao imati barem dvije stvari.Popis hvata nečije oči zbog izgleda , ali previše popisi može pobijeditičitatelji , nanoseći im da ne znam gdje da se usredotočite svoju pozornost . Koristitepopise za razboritonaglasiti i razjasniti .Savjeti za Korištenje Popisi

nabrojat usporedive stvari .

Koristite paralelna struktura tijekom .

Koristite kratke rečenice , fraze ili riječi .

Osigurati adekvatne prijelaze prije i poslije popisa .

koristiti metke , kada mjesto ili slijed nije važno .

Ne prenaprezanja popisi .

3.1.6 NaznakeNaznake su korisni za privlačenje pozornosti . Oni su obično kratki - na jednoj rečenicina stavku u dužini - krenula s kutijom ili sjenčanje . Možete koristiti Naznake u raznimsituacijama . Oni mogu sadržavati sažetak ključnih informacija koje želite da svipročitati , ilipodupire činjenica da želite naglasiti . Naznake se često koristi kako bi sečitatelji skeniranje za točke od interesa koji bi inače mogli propustiti . Naznake trebaobitikoristiti štedljivo , i oni se moraju odnositi na tekst na stranici na kojoj se pojavljuju .3.1.7 Slike i tabliceSlike i tablice mogu pružiti instant razumijevanje složenih informacija . onimoraju biti točne , smislene i opisao u tekstu . Kad god je moguće , zadržati figure



i tablica u neposrednoj blizini tekstu koji ih opisuje , tako da čitatelj neStyle & ObičajOtk 2,00 , 1. rujna 20043:4Uvod u tehničkom pisanju

moraju okrenuti leđa i naprijed između tablica ili i njegov opis . Uvijek se odnosena slici ili stol po broju , ne " iznad " ili "ispod ".Broj slike i tablice u nizu . Ako je sekvencijalni numeriranje kroz tekst ,primjerice stranice 1-204 , broj likova i stolovima u nizu . Na primjer , ako postoje83 figure , označiti ih Slika 1 do 83 slika . Ako postoje 18 tablice , označiti ih Tablicu1 do Tablica 18 .

Akoje tekst popisao dijelu ( str. 1-1 na 1-34 , stranica 2-1 2-75 , itd. ) , brojslike i tablice s odjeljku broj , nakon čega slijedi broja na slici.Dakle , 10 figure u točki 4. dokument treba numerirati Slika 4.1 putemSlika 4.10 . Pet stolovi u istom odjeljku će biti numerirane Tablicu 4.1 kroz tablici4.5 .

Tablice trebaju imati smislen red i natpise stupaca . Ako koristite kraticu ,objasniti njegovo značenje u fusnoti . Na primjer ,opće čitatelj ne može znati što" Po " ili " Amt " su u stupca osim ako se pravilno definirati u podnožju ,Ključ , ili u tekstu izvješća koja opisuje stol .3.1.8 uputstvaKada se odnosi na poglavlja ili dijelove koji se pojavljuju na drugom mjestu udokumentu , koristitecross- reference voditi čitatelja na mjestu . Unakrsne reference pomoći čitateljuznam kad više informacija o temi je dostupan . Koristite cross- referenceu cijelom tekstu se odnose na podatke koji se također odnosi na trenutnu raspravu .zajedničko je format ( Vidi <chapter> , <section> ) .3.1.9 Fusnote i BilješkeBilješke navesti izvor informacija ili pružaju kratka objašnjenja koja podržavaposebna izjava , ali nije sastavni dio logičan tijek teksta . Fusnote se pojavitina dnu stranice teksta. Indeksi u tekstu odgovaraju brojevima fusnote ,kao this.2 Bilješke su numerirani na isti način , ali sve bilješke svirki pokraju poglavlja ili dokument . Općenito , uporaba Bilješke kada bi inačeviše od tri fusnote na određenoj stranici , ili ako fusnote su vrlo dugotrajan .3.1.10 otpremninaIzbjegavajte korištenje iste riječi dvaput u rečenici . Na primjer :Umjesto " Ostale značajne značajke programa uključuju trošak izvješćivanja ,Detaljan plaće hvatanje , upravljanje vremenom modula i koristi značajke . "Koristite " Ostale značajne značajke programa su :• rashodi izvješćivanja• detaljni plaće hvatanje• upravljanje vremenom modula2 Fusnote se pojaviti na dnu iste stranice kaotekst su notating .Style & ObičajUvod u tehničkom pisanju 3-5Otk 2,00 , 1. rujna 2004



• koristi itemization• porezna itemization "Umjesto " Regulatorne agencije počele regulirati sve porezzahtjevi i isplate . "Koristite " Regulatorne agencije prate sve korporativne porezne propise i

plaćanja . "3.1.11 Final EditKako bi se osiguralo profesionalni podnesak , ostavite vremena za konačnu ocjenudokumentu .Osim standardne provjere pravopisa i gramatike , vaša završna provjera trebauključivatipregled ključnih pojmova i akronima kako bi bili sigurni da su napisane i definira kadasu se prvi put pojavljuju . Provjerite je li odgovarajuće informacije pojavljuje nanaslovnici , uključujući

Autori , datum i broj sveska ako je potrebno . Uvjerite se daBrojevi stranice ibrojevima sekcija za cross- reference i unose u tablici sadržaja i indeksa se

točno , jer to može promijeniti tijekom sastavljanja dokumenta .Konačno , uključuju signoff list za recenzenta komentare i datum ovi komentari suzbog .Pogledajte list uzorak koji se pojavljuje uz popis na kraju ovog poglavlja signoff .3.2 Wasted riječi i fraze kako bi se izbjegloNakon što napisati rečenicu , to gledati preko i pitati da li postoje bilo kakve riječi kojemože smanjiti bez utjecaja na značenje . Ako je tako , početi rezanje , jer jekraća verzijaobično bolja . Izbjegavajte riječi i fraze koje ne dodaju značenje u rečenici . nekiRiječi i fraze koje treba izbjegavati su :♦ stvarna , zapravo♦ sve ( zamijenite "svi " )♦ kao što su♦ da li ( zamijeniti s "da li " )♦ kao što znate♦ u sadašnjem trenutku ( zamijenite " sada " )♦ osnovi♦ tome da ( zamijenite " Od " )♦ potpunosti♦ suštini♦ iznimno♦ kako bi se ( zamijeniti s "u" )♦ u smislu♦ irregardless ( ovo nijeriječ ; uporaba " obzira " ili " neovisno " umjesto )♦ može se vidjeti da je♦ je naznačeno da♦ Predviđeno je da seStyle & ObičajOtk 2,00 , 1. rujna 20043-6Uvod u tehničkom pisanju



♦ da je neophodno da♦ zanimljivo je da je♦ značajno je da♦ treba napomenuti da♦ treba imati na umu da

♦ Štoviše♦ zahtijevaju ( zamijenite " zahtijevaju " )♦ sasvim♦ potpuno♦ koriste , iskoristivost ( zamijenite " korištenja " )♦ vrloJoš nekoliko fraza koje treba izbjegavati slijediti , zajedno s prijedlozima za poboljšanje .sposobanIzraz je sposoban - ing se obično može se mijenjati s aktivnim glagolom s mogu - .Jednako kaoNešto može biti jednako važno , ili to može biti važna , ali to ne može biti jednako

važno .Činjenica daObično nepotrebno . Često možete ispustiti činjenicu i koristiti samo to sama . Naprimjer :Umjesto " Ja sam iznenađen činjenicom da je izvješće nepotpuno . "Koristite " Čudim se da je izvješće nepotpuno . "Na osnovi -Obično nepotrebno . Na primjer , zamijenite " na dnevnoj bazi " s " svakodnevno . ", Kako bi seRiječ sama radi u redu .Style & ObičajUvod u tehničkom pisanju 3-7Otk 2,00 , 1. rujna 20043,3- Z ReferenceSlijediabecedni popis uobičajenih riječi ili fraze i interpunkcijskih znakova kojipisci često zloupotrebljava .IliKoristise u mjestukada je prethodi samoglasnik zvuk , a ne samosamoglasnik . TozbunjujeLjudi najčešće s akronima i ostalim kraticama . Često , pisci mislim da je u redukoristiti "" ispred jednog skraćenica ( kao što je MRI ) , jer "" ide samo prije vokala .Međutim ,zvuk određuje koji članak za korištenje . To je "MR ", uz pretpostavkuizgovoriti " em su oku . "Utjecati odnosu EffectUtjecati obično jeglagol , učinak je običnoimenica . Na primjer , " odluku povjerenstvautječe na čekanju zakonodavstva . Učinak odluke je odgoditi ove račune . "Pridjev za efekt je na snazi , kao u " rada Odbora je na snazi . " Utjecaj kao glagolznači " dovesti do " ili " ostvariti " kao u " kako bi utjecati na promjenu . "Utjecati , kaoimenica koja označava opći emocionalni ton osobom . Afektivnog kaopridjev



znači "u vezi ili budi emotivnu reakciju . " Ovi uvjeti se obično koriste upsihološki dokumenti .

Alternativni , AlternativeZamjenski ( kao pridjev ili glagol ) znači ići natrag i naprijed između dvije stvari , kao uizmjenjuju Ponedjeljkom ( tj. svaki drugi ponedjeljak ) , ili "mi izmjenjuju između susreta

ovdjete u Sacramentu . " Alternative znači drugačiji način obavljanja stvari . " Jednaalternativa

jemajka , drugi jeniz nasipe . "Među odnosu izmeđuSlijedite ovaj jednostavan pravilo : Koristite između dvije stvari , među više od dva .I / iliI / ili je ponekad potrebno u pravnim dokumentima , ali samo clutters drugo pisanje .

jedanriječ ilidrugi je obično dovoljno .Uvjerite , Osigurati , Osiguraj

Osigurati sredstva " kako bi bili sigurni . " Na primjer , "zakonodavstvo osigurava pristup javnostiObala . " Ovo je uglavnomriječ koju želite u izvješćima ili poslovne komunikacije .Osigurajte jeposebna riječ koja znači izdvojiti sredstva u slučaju gubitka : " Mi osiguratinašimcar od posljedica nesretnog slučaja . " Jamčim znači osigurati verbalno uvjeravanjanekome . nikadkoristite uvjeravam u smislu " Sigurno daje tekst točan " ,točna riječ u ovomIzraz je osigurala i uvjerite . Vi samo možete uvjeriti nekoga da je to točno . Da bi seizbjeglazbunjenost, " pazite " ili " biti siguran " često su dobri alternativni izrazi . Da bi seizbjeglazbunjenost, " pazite " ili " biti siguran " često su dobri alternativni izrazi .Style & ObičajOtk 2,00 , 1. rujna 20043-8Uvod u tehničkom pisanjudvotočkaDebelog označava stanku za objašnjenje , ekspanzija, brojenje , ili razrada . Koristitedebelog uvesti popis : jedan predmet , predmet dva, i tri točke . Koristite ga za pružanjepotkrepljuju dokaze za tvrdnje da prethodi debelo crijevo ili dati primjer .Složeni Riječi su pridjeviKada spojite dvije riječi za opisivanje imenica , koristiti crticu između njih , akoOpis dolazi prije imenica . Ako je u pitanju poslije imenice , ne koristite crticu . zaPrimjer : "Izvješće je dobro napisano " , " Oni su bili zaprepašteni dobro pisanoizvješće . "Za temeljitu objašnjenje o tome kada i kada ne bi crticom riječi , odnose se naChicago Manual of Style .Obuhvaćaju odnosu SastaviObuhvaćaju znači " sadrže " ili " uključuje ". Sastavi znači " predstavljaju , u obliku



stavljanjemzajedno . "Razlika između obuhvaćaju i sastaviti je da dijelovi skladaticjelini, a cijela obuhvaća dijelove . Na primjer , "Knjiga se sastoji od 24poglavlja. "" Obrazovan inženjeri sastaviti komisiju . " Izbjegavajte sastoji od ( jedannačin da zapamtite što ne bi iskoristili " su mjesta " ) .

crticaCrtica jeneformalni način obilježavanja usputna izjavu - iliskretanje izGlavna misao - u usred rečenice . Izbjegavajte korištenje crtice u formalnom pisanja ,koristitezagrade ili restrukturirati kaznu .drugačijiRiječ je često drugačija suvišan , jer se u nekoliko različitih opcija ili više različitihSudionici . Nekoliko opcije i mnogi sudionici imaju isto značenje .Na primjer u odnosu na npr.Kratica npr. je za Latinsku exempli gratia , što znači " za primjer . " Ie jeUkratko za Latinsku id est , što znači " da je . "Zarez treba slijediti ( i prethode , ako

prikladno) obje kratice . Budući da ti uvjeti često su zbunjeni , to je često jasnijikoristiti riječi na primjer, ili da je umjesto ove kratice .svakiSvaki zahtijeva Glagol u jednini i zamjenice jednine . Nemojte pisati " Svatko odradovi ocijenjeni su " ; korištenje " Svaki od radova je ocijenjena kao " ili ( bolje)" Svaki papir je ocijenjena . "Podrazumijeva odnosu zaključitiZvučnika podrazumijeva nešto po aludira na to ;slušatelj zaključuje nešto od onoga štoon iličuje . Ne koristite ih naizmjenično . Na primjer : " U izvješću se podrazumijeva daSituacija je bila kritična , ali nije predstaviti jasne alternative . " " Iz zaključaka ,čitatelji su ostavili da zaključiti da je hitna akcija je potrebno . "Style & ObičajUvod u tehničkom pisanju 3-9Otk 2,00 , 1. rujna 2004Manje u odnosu ManjeManje znači "nije jednako " ; manje sredstva koristiti za manje neograničenimkoličinama , " ne kao mnogi . "poput vode ili zadovoljstvo . Ako možete računati stavke , međutim, koristiti manje .Primjerice ,Znak na izričit naplata trebao pročitati : " Devet stvari ili manje . "brojeviStil pravila za brojeva može varirati , alinajvažnija stvar je da ostanedosljedni u cijelom dokumentu . Evo nekoliko prijedloga o korištenjuBrojevi u tekstu . Pogledajte The Chicago Manual of Style za situacije koje nisunavedene ovdje .Općenito , sricati brojeve manje od 10 , napisati brojeve 10 ili veći , kao figura . ovoprimjenjuje se i kardinal i redni ( sricati prvi ili peti , ali koriste 14. ili 122. ) )brojevi .Neke iznimke u pravilu uključuju :



♦ Express vrijeme u brojkama : " 11:30 , 16:00 »♦ Nemojte početi rečenicu s brojkom : bilo sricati broj ( ipak velika) , iliprepisati rečenicu tako da ne počinje s brojem .♦ Vrlo velik broj se izražava u brojkama iza kojih se nalazi riječi milijuna , milijarde ,itd. Na primjer : Ne milijarda , ali 1 milijarde . Ovo pravilo se odnosi na opće teksta

samo . Znanstvene informacije ili tablice može zahtijevati punu numeričku izraz .♦ Koristite podatke za sve postotke i decimale u rečenici . Na primjer : "Rezultat od 3 posto je postignut u prosjeku 3,5 puta . "♦ Koristite podatke za fizičkim količinama i mjerenja . Na primjer : 6 metara ; 3 kubičnaNoge ; 9 galona.♦ Brojevi koji se primjenjuju na istu kategoriju tretiraju podjednako u rečenici . zaPrimjer : " Od 25 knjiga preporučenih , četiri od inženjera samo da bi pronašli sedam . "" U protekle četiri godine , 22 su izvješća pisana na temu . " U prvom primjeru ,Knjige su jedna kategorija , tako da su obje brojevi pišu kao figura .zagrada '()'Zagrade Mark informacija koje nisu dio glavne misli kazne ili

st. , ali pruža relevantne dodatne informacije . Akousputna opaskapojavljuje u jednoj rečenici , ne koristite rok u zagradama , čak i ako jedovršiti rečenicu . Akousputna primjedba stoji sama ipotpune rečenice ,stavite rok u zagradama .poIzbjegavajte korištenje po značiti skladu . Koristite po izraziti matematičke odnose ,kao što metara u sekundi .Style & ObičajOtk 2,00 , 1. rujna 20043-10Uvod u tehničkom pisanjuPrijedlozi na kraju osudeIzbjegli završava rečenice i klauzule s prijedloga , kao što se , s , s , u , i u.Umjesto pisanja " teme koje želite pisati o , " razmotriti " temama o kojima smonamjeravate pisati . " Prijedlozi uglavnom idu ispred riječi su izmijeniti .S druge strane , ne nekapotreba da se presele na prijedlog učiniti vaše pisanjenespretno ilizasjeniti . Akoje kazna jasniji s konačnom prijedlogu , neka ga stajati . zapamtitiChurchill je poznato primjedba na svom uredniku : " To jevrsta gluposti s kojima samneće staviti . "točka i zapetaZarez osigurava razmak između dviju rečenica kad drugiKazna slijedi neposredno izprve . Na primjer : "prevladava vjetar izsjever , visoki banaka na jugu su dizajnirani kako bi se omogućilo za to " Obaizraz prije.zarez ijedna sljedećeg to mora biti cjelovita rečenica , rečenice moraizravno odnose jedni prema drugima . Na ovaj način ,zarez eliminira korištenje vezivniizrazi , kao što su na taj način , osim , i stoga .

jedinstvenJedinstveni znači " jedna od vrsta . " Nema stupnjeva jedinstvenosti : nešto što je bilo

jedinstveni ili nije . Ako želite riječ koja implicira stupnjeva , koristite posebna ili



neobične .3.4 SažetakDobro pisanje jekombinacija uredno ideja prezentiranih jednostavno isvrsishodnostod riječi , fraze i konvencijama . To uključuje korištenje liste, popis literature, ličnosti itablice , i kratice . Sveukupno , tekst bi trebao biti u aktivnom stanju , prezent , i koristiti

kratke rečenice , deklaratitvno . Provjerite vaše pisanje kako bi se uklonili nepotrebneriječi ,zamjena jednostavne riječi za pretjerano složenih one , i osigurati da ste koristili riječii fraza ispravno. Uređivanja popis pojavi na sljedećoj stranici .Podsjetnik 3 - MontažaUvod u tehničkom pisanju 3-11Otk 2,00 , 1. rujna 2004Podsjetnik 3 - Montaža

Provjereno za prezent, aktivnog glasa .

Provjereno za suvišnih riječi .

Koristi rodno neutralna formulacija .

Akronimi i kratice definirane pri prvom spominjanju .

Provjereno za temu / glagol sporazum .

korištenih kratica i ostale terminologije dosljedno .

Provjereno pogrešno napisane riječi ( nemojte se oslanjati isključivo na provjeru

pravopisa ) .Provjereno za pravilnu uporabu interpunkcije .

Slike i tablice numeriraju , a pojavljuje se u ispravnom položaju .

popratna dokumentacija nalazi se dodacima .

slike , tablice, i prilozi iz točno.

grafičkim oznakama i numerirane popise imaju paralelnu gradnju i dosljedan

interpunkcije .razine naslova slijede sekvencijalno . Ako ste stvorili jednu podnaslovu , morate imati

najmanjedva. Na primjer , ne stvaraju naslova 1.1.1 beznaslova 1.1.2 . Ako je informacijaza samo jedan podnaslovu postoji, sve to bi se trebao pojaviti u glavni naslov , 1.1 .

Paginacija točna ( na primjer , ako su dijelovi brojevima 1 -X, 2 - x , itd. , svaki

poglavlje počinje na stranici x - 1 ) .Rječnik identificira sve ključne pojmove .

Updated i ovjeren TOC i indeks unose .

Naslov stranica navodi naslov, autore , volumen broj, datum .

prilogu znak - off list s komentarima i datum koji su zbog revizije .

Predstavljena :Uzorak pregled znak - off ObrazacOtk 2,00 , 1. rujna 20043-12Uvod u tehničkom pisanjuPredstavljen od:Naziv projekta :Datum :ostvarivi :



Sadržaj pregled :recenzenti 'Upute :

Datum dospijeća :Komentari

Autor :Komentarirecenzenta :Pregledao sam priloženi dokument s promjenama kao što je navedeno u pisanomobliku .Potpis potvrđuje odobrenje da se uključi komentare i nastavite sa sljedećem nacrtu .

____________________________ Ime recenzenta , Naslov

____________________________ datumKorespondencija i memorandumiUvod u tehničkom pisanju 4-1Otk 2,00 , 1. rujna 20044 . Korespondencija i memorandumiKorporacije i vladine organizacije imaju standarde za dopisivanje , e-mail ,i neke vrste memoranduma . Osim toga , često postoje vremenski i sadržajnoZahtjevi za kvalitetu zapisa za tvrtke koje imaju sustav upravljanja kvalitetom .Ovo poglavlje obuhvaća odgovarajući oblik i sadržaj :

Email

Dopisivanje

dnevnog reda sastanaka i minute

memorandumi

Popis se na kraju poglavlja , zajedno s uzorcima i predložaka.4.1 DopisivanjeU svoju ulogu kao tehnički pisac , možda ćete morati odgovoriti u pisanom obliku nadruge tvrtke ,

Agencije , kolege, upravljanje , ilijavnosti. U mnogim slučajevima ,korespondencijupostaje dio javne evidencije , tako da je važno da se pisana komunikacija

jasne i točne .4.1.1 Držite Komentari unutar obuhvataorganizacijeodgovornostProvjerite svoje e-mailove i pisma izražavaju organizacije poziciju bez kritiziranjaili vrijeđa primatelja . Dopisivanje treba ostati unutar granicaProjekt ,područje tražene poruci , a organizacija je politika . Komentariizvan tih područja može izazvati ljutiti komentar , a oni nikada ne bi se poboljšalaugled organizacije ili odnos s drugima . Primjer slijedi .Umjesto ( U pismu Grada Oza uređenja Odjela vezi izvješće )" Ovaj projekt nije u skladu s Gradom Oza" priobalna Koridor politike . "Problem : Voda osoblje Općina ne bi se usudio reći o Gradunedosljednosti unutar gradskih politika i projekata . Ovo nijeDistriktaUloga .



Koristite "Općina se bavi projekta utjecaja na obalne hodnikuiz Oza Creeku . "Rješenje : Riječ je o dijelu uloga za nadzor i zaštitu potok . Predstavite bilozabrinutost oko projekta učinak na potoku samo kao oni odražavajuUloga organizacije .

Korespondencija i memorandumiOtk 2,00 , 1. rujna 20044:2Uvod u tehničkom pisanju4.1.2 eliminirati osobna mišljenjaDržite osobne osjećaje i mišljenja iz korporativnih pisama ili e-pošte . To može bititeško, ako se osjećate jako o nekim aspektima projekta , ili vidjeti nešto štoneki su možda propustili . Ako je toproblem javne politike , napisati osobno pismoupravno tijelo pod svoje ime , na svoju tiskanice , na kućnu adresu .Vi kao građanin ima pravo komentirati i imati mišljenje , ali to je neprimjerenokoristiti svoj položaj s tvrtkom ili državne organizacije za ovu namjenu .

Primjer slijedi .Umjesto ( U pismu o utjecaju na okoliš izvješće ) "Izvješćene daje odgovarajuće informacije popratne izjave da postojinastavak velike potražnje za golf igrališta u gradu , niti se to usporediti ovu potrebuna druge rekreativne potrebe u gradu . Zbog utjecaja na okolišProjekt ičinjenica da je ovo jedinstvena parcela se nalazi u gradskom vlasništvu ,Grad bitrebaorazmotriti drugu vrstu park uporabe koji je bolje koristi i štitiprirodnikarakter parka . "Problem : Ovo jeosobno mišljenje , a ne bi trebao biti u vladinom izvješću .Skinite gornji primjer iz izvješća . Ako upotreba ovog jedinstvenog prostora je odosobno tiče , napisati pismo na svoj kancelarijski sa svojim komentarima .Kad navodeći profesionalnu mišljenje o ime organizacije , navesti ciljOsnova za mišljenje ili navesti izvor ( planiranje studija , regulacije , priručnik, i sl. ) kadaprimjereno, i pridržavati se načela raspravljali u 2. poglavlju . Za primjerestručna mišljenja iskazati na zaključke ili preporuke , vidi odjeljke 5.1.4 i5.1.5 ovog priručnika .4.1.3 Korištenje odgovarajućem formatuPisma treba navesti svoju svrhu u prvom stavku , pružiti podrškuInformacije u tijelu , i sažeti svoj sadržaj u završnom stavku . većinatvrtke i vladine agencije imaju specifične politike za dopisivanje . pismoPredložak za Microsoft Word koji u sebi sadrži neke opće smjernice pojavljuje na krajuovog poglavlja . U nedostatku takvih direktiva , koristiti ručni Gregg kao referencastandard za poslovnu komunikaciju .4.2 EmailSve, e-mail postajevažno sredstvo komunikacije . E-mail trebapridržavati istih standarda koji vrijede za dopisivanje . Bilo unutar iliizvan tvrtke , e-mail je dio organizacijski ili javni zapis . Često se koristi uSud bi potkrijepio događaja .Jednostavnost i brza -vatra priroda e-mail može dovesti do neprikladnog sadržaja . Ovaj



diofokusira na osnovnom e etiketa , očekivanja što se sadržaj i nekoliko savjeta o tomekakomaksimizirati koristi od e-maila .Korespondencija i memorandumi

Uvod u tehničkom pisanju 4-3Otk 2,00 , 1. rujna 20044.2.1 DržavnaTvrtka OčitoKoristite e-mail liniju podložno jezgrovito definirati što je e-mail o tome . Na primjer :Umjesto oblikovanje pitanjaKoristite prijedlog o Word predložakaUmjesto jučerašnjeg sastankaKoristite ABC značajke i funkcije Sastanak 10-11-02Nemojte zloupotrijebiti e-mail -a reply značajke ( Re : xxx ) izreći tu temu . Ako ste sepreselili nanova tema , unesite novu liniju predmet .

Jasno identificiraju svoju publiku i bilo kakve akcije koje očekujete od njih . Pošaljiprijepiseoni koji trebaju biti informirani , ali od koga ništa očekuje .4.2.2 pisati kratke , čitljiva komunikacijeKao što napisati svoj e-mail , imajte na umu da mnogi ljudi dobivaju između 20 i 200 e-maildan. Ako želite svoj e-mail kako bi se čitati i odgovorio , napraviti temu i bilo koju tipkuInformacije jasno u prvih nekoliko rečenica . To bi trebao biti jasan , pristojan, i kratko .Uključite pojedinosti koje pomažučitatelju identificirati informacije . To je možda biotjedana

jer su mislili da o ovoj temi .Umjesto " Žao nam je što kasnim na dobivanje natrag na vas , ali moj raspored jepakiran . Znam da je potrebno ove informacije prošlog tjedna , ali nadam se da je jošuvijek relevantni( osmijeh ) . U pogledu rebalansa u tablicama pratećih odjeljak 1 , moramzatražio podatke koji su nam potrebni Jane . Ona jeonaj koji ima pristupinternih izvještaja koji pružaju ono što nam je potrebno . Obećala je da se vratim namenešto prije. To je bilo prije tri tjedna , ali ja još uvijek čekam . Hoće li znaš što je prijekao što sam dobiti informaciju . "Koristite " Vi me zamolio da daju izmjene na stolove podržava stavka 1.Gornja Rijeka Guadalupe izvješće o provedbi . Jane Sable na Vojske korpusaInženjeri jepojedinac koji mogu pružiti ove informacije . Ja sam je kontaktiralae-mail i broj telefona ( e-mail : [email protected] , telefon xxx -xxx - xxxx ) , ali još nisudobio informaciju . Ja ću pratiti jednom tjedno , a prijaviti bilo kakav napredak . ja seispričavamzbog kašnjenja . "4.2.3 zaposliti Email BontonE-mail treba zaposliti osnovnu pristojnost , standardni slova i interpunkcija , aDobar gramatiku . Ako dobijete e-mail ljut , suzdržati od odgovora u naturi . Angry



porukene potiču profesionalni imidž .Neki brze konvencije su pronašli svoj put u prihvatljivom emailese . To uključujeispustite slova iz riječi ( thru i SHD su uobičajene ) , kao btw ( by the way ) ,EOD ( na kraju dana ) , po mom skromnom sudu ( po mom skromnom mišljenju ) , itd.

To su korisni prečaci štoKorespondencija i memorandumiOtk 2,00 , 1. rujna 20044:4Uvod u tehničkom pisanjuSve dok niste okreće svoj e-mail u akronim juhu . Na primjer : BTW IMHO ovoSHD biti učinjeno od strane EOD . Koristite kratice rijetko , ako uopće .Više nesporazumi javljaju u pisanom obliku nego u usmenom razgovoru , jer steNe mogu čitati govor tijela osobe ili čuti nijanse u glasu . To vrijedi za obadopisivanje i e-mail . U razmjeni e-pošte , pod nazivom"nit ",osoba koja dolazi naRazgovor u sredini će morati cijeli thread da bi mogli slijediti

raspravu . Ako vam je potrebno da biste izbrisali nešto , provjerite je li sverelevantneInformacije ostaje . U većini slučajeva , to je bolje ostaviti neke neobičneInformacije nego griješiti na iznošenje previše .4.3 dnevnog reda sastanaka i konferencijske MinutesDnevni red i zapisnik prije i poslije slika istog događaja . Dnevni redDokumenti koji je bio pozvan i sastanka nakanu, iminute dokument koji jesudjelovali i što se dogodilo .4.3.1 dnevnog reda sastanakaPodijeliti dnevnog reda sastanaka prije sastanka . To vam omogućuje da sudionici znajuSvrha sastanka , koliko dugo to može potrajati , i da li im je potrebno za pripremumaterijalai / ili informacije . Ovisno o predmetu ,program može pomoći čak iNeformalni sastanak biti produktivniji .Dnevni red treba sadržavatisljedeće :1 . Datum , mjesto , vrijeme početka i , ako je moguće , očekivano vrijeme završetka2 . Popis sudionika3 . Svrha / cilj4 . Pitanja će se raspravljati5 . Stavke biti predstavljeniUključi materijale za pregled , zajedno s dnevnog reda , ili ih distribuirati i ispredSusret kako ljudi imaju vremena za pregled materijala prije nego što im je potrebnokomentirati .To štedi vrijeme i smanjuje mogućnost siromaštvo follow - up sastanak naistopodručja . Sljedeći jeprimjer plana za unutarnje sastanku više autorapriprema planske studiju :Korespondencija i memorandumiUvod u tehničkom pisanju 4-5Otk 2,00 , 1. rujna 20044.3.2 Sastanak ZapisnikKonferencijske minute dokument što se dogodilo na sjednici . Oni nisupriliku



predstaviti položaj ili dodati nove materijale i komentare .Format bi trebao slijediti blisko dnevni red , uključujući :1 . Datum , vrijeme i mjesto sastanka2 . Imena onih koji su nazočni3 . Svrha sastanka

4 . Svaki problem riješiti i Naglašava rasprave5 . Atomu bilo kojeg materijala iz ruku u vrijeme6 . Ishod ili odluke ( akoje dogovor da se ponovno sastati , imajte na umu mjestoi vrijeme sljedećeg sastanka )Za većinu susreta , jednostavno dokumentiranje tema sastanka i odlukama koje sudonesene trebao bitidovoljna . Sljedeći je na uzorku od konferencijskih minuta da odgovara iznad uzorkaDnevni red :Dnevni red : Autori Sastanak se pripremiti za XXX Reference ManualDatum : 17. lipnja 2003Vrijeme : 1-2 sati

Mjesto : Zgrada X , Y Konferencija SobaSudionici : Ime 1Ime 2Ime 3 ...Namjena : Za raspravljati uloge i rokovima za razvoj XXX Reference Manual

Ako ne možete sudjelovati , molimo Vas da obavijestite <IME> do kraja dana 15. lipnja .1 . Upoznavanja : 5 minuta2 . Pregled doprinosa zadatke , mjesto datoteke , stil vodič , rokove : 15 minuta3 . Pregled podataka i izvor materijala , identificirati nedostatke : 20 minuta4 . Odrediti strategiju za dobivanje podataka koji nedostaju : 15 minuta5 . Raspored sljedeći sastanak : 5 minutaKorespondencija i memorandumiOtk 2,00 , 1. rujna 20044-6Uvod u tehničkom pisanjuUvijek priložiti kopije materijala distribuiranih na sastanku ili na umu gdje se mogu naćiih . Budući minute često pregledavaju mjeseci ili godina kasnije , važno je da imajupristup prateću dokumentaciju i zapisnik .4.4 memorandumiPostoje mnoge vrste dopisa . Dva opisani ovdje su tehnički dopise idokumentiranje dopise . Obje vrste često se koriste za praćenje tehničke projekte ,pogotovo akoorganizacija ima procedure za osiguranje kvalitete na mjestu .4.4.1 Tehnički dopisa

Tehnički dopise su kvalitetni zapisi koji se koriste kao dio inženjeringa ili planiranje iprojektiranjepostupke . Osoblje pregled i komentar o sadržaju i preporuke utehničkih podsjetnik prije projektnih timova ili konzultantima mogu nastaviti sa svojimradom .Te bilješke se koriste za procjenu pitanja i razgovarati o problemima , ciljevima, planomodabira ,



i dizajn . Podsjetnici trebalo biti jasno , na točku , i formalno .Tehnički dopise treba sadržavatisljedeće :Naslov : ( Pokazuje predmet i vrstu tehničke dopisu . )Pripremio : ( imenaosoba ili osoblja inženjering i konzalting tvrtka . )Zapisnik Autori sastanak kako bi se pripremili za XXX planiranje studija

Datum : 17. lipnja 2003Prisutni : Ime 1Ime 2Ime 3 ...Sljedeći sastanak : Ništa rasporeduSvi autori su se sastali kako bi odredili uloge , odgovornosti i rokovima za njihovoPrilog proučavanju XXX uređenja . <IME> Upravlja ovaj projekt . <IME>predstavio suradnike , i pod uvjetom da je URL za vodič divizije stilu , kaoi hard kopiju Kontrolnog popisa pregled dokumenata .Sporazumi i zadaci ovog sastanka su kako slijedi :1 . Svi autori će završiti popis i priložiti sa svojim prijedlozima podnesaka .

2 . Svi autori su se složili kako bi se zadovoljile priloženi raspored isporučeno .3 . Projekt editor , <IME> , kontaktirat će autore tjednik ih podsjetiti zbogdatumi .4 . <IME> Je odgovoran za dobivanje podataka koji nedostaju iz xxx .5 . Mi ne predviđaju potrebu da se ponovno sastati kao grupa tek nakon dostaveNacrt izvješća .6 . <IME> Će zakazati sljedeći sastanak nakon konzultacija sa svim autorima putem e-mailanakon što jenacrt izvješća je završena .Korespondencija i memorandumiUvod u tehničkom pisanju 4-7Otk 2,00 , 1. rujna 2004Datum : ( Prikazuje trenutni datum i / ili datum pregleda Primjerice , Prijavljen 10.svibnja .2004 Recenziju 3. lipnja 2004 . )Sažetak : (Naziviprojekata , opisuje svoju svrhu , te ukratko navodi nikakve zaključkeili preporuke u dopisu . )Pozadina : ( Uključuje kratku raspravu o pozadini projekta , a zašto je to problemima doći . )Procjena : ( razmatra pitanje u dubinu , i ocjenjujeproblem ili situacija i njenmoguća rješenja . Ona također uključuje bilo kakvih pitanja za sudionike treba uzeti uobzir . )Preporuke : ( Pruža detaljne zaključke i rješenja za preporučenePitanje ili problem. )Jasnoća je iznimno važno u tehničkim dopise , pa iznijeti svoje misli prije nego štopredstavljajući ih . Koristite jednostavan , jednostavan jezik .Umjesto "Svrha ove tehničke memoranduma je predstavitikonačniarhitektonski dizajn kriteriji koji su u svakom postrojenja za obradu vode . To se odnosina osnoviPredložene ozona strukture, tekućeg kisika skladišta , washwater pojašnjenja



Zgrade i nove kemijske sadržaji . Ovaj dopis je finaliziran nakonprimanje i uključuje pregled komentare . "Problem :Izjava uspije identificirati jasno koje biljke se raspravlja . Ona koristinejasne , izgubiti fraze i pasivu .Koristite " Ova konačna tehnička Memorandum uključuje prethodne komentare na

pregledOpćina Oz vode u odnosu na projektantskih kriterijima za novog vodupostrojenja za pročišćavanje u Distriktu. Ti kriteriji uključuju :♦ Predložene ozona strukture♦ tekućeg kisika za skladištenje♦ Washwater pojašnjenja zgrada♦ Nove kemijskih postrojenja "Primjer tehničkoj dopisa i predložak su se na kraju ovog poglavlja .4.4.2 dokumentiranje dopisaDokumentiranje dopise staviti razne informacije u pisanom obliku kao formalni zapis .Kvaliteta zapisi za većinu korporativne ili državne projekte uključujudokumentiranje

podsjetnik na probleme i ciljeve, a dopis o odabiru projekata . Ostali dopise jednostavno umu dostavu dokumenta ili završetak prekretnicom . Svaka vrsta dopisasadrži različite informacije .Općenito , dokumentiranje dopise uključuju sljedeće :Naslov : ( Pokazuje predmet i vrstu dokumentiranja dopis . )Pripremio : ( Nazivipojedinac ili tvrtka . )Korespondencija i memorandumiOtk 2,00 , 1. rujna 20044-8Uvod u tehničkom pisanjuDatum : ( Pruža trenutni datum . )Re : ( Pruža ukupni broj identifikacije projekta ili drugi podaci za identifikaciju . )Pozadina : ( Uključuje kratku raspravu o pozadini projekta , a zašto je to problemima doći . )Dokumentacija / Obrazloženje : ( Uključuje informacije koje čini tijelomemo - primjerice ,dokument dostavljen , i pregled raspisala , pregledkomentara , ili druge informacije . )Primjer dokumentiranja dopisa i predložak nalaze se na kraju ovepoglavlje .4.5 SažetakSjeti se da predstavljaju svoju organizaciju kad pišeš kao svog zaposlenika .Informacije koje predstavljaju mora biti činjenično , nepristrano , te uz potporu točne up-to -datepodatke . Bilo diktira statutom , ili traži od politike tvrtke , važno je koristititočne format i protok informacija , kao što pišete . Ovo poglavlje sadrži samonekolikoprimjeri . Upoznajte se sa zahtjevima svake vrste dokumenta za vašuOrganizacija . Koristite popise kako bi vam pomoći organizirati informacije u jasan ,koncizan , dobro napisan dokument .Uzorak pisma i dopise pojaviti nakon provjeru, zajedno s predlošcima za tehničkui dokumentiranje dopise . Predlošci nemaju naslove ili brojeve stranica .



Korespondencija i memorandumiUvod u tehničkom pisanju 4-9Otk 2,00 , 1. rujna 2004Podsjetnik 4 - Korespondencija &memorandumi

PismaPrati standardni format (vidi uzorak , koji prati ovaj popis )

počinje s uvodnom paragrafujasno navodi svrha pisma

Pruža logičkih , podržava odlomke za tijelo pisma

Sažima ključne točke u završnom stavku

razgovarao samo stavke u nadležnosti organizacije

odriče osobnim mišljenjem

Održava profesionalni ton cijeloj

E-mailUtvrđuje temu ove e-mail (nijeprethodni ) u liniji

Održava sadržaja kratka i do točke ( jedan zaslon informacija ako je moguće )

Koristi pravilan jezične i pravopisne

razgovarao samo stavke u nadležnosti organizacije

odriče osobnim mišljenjem


Memorandumi ( vidi uzorke tehničke i dokumentiranje memorandumu koji prate ovupopis )

Prati standardnom formatu

Sažima ključne točke u početnoj točki

Održava sadržaja kratka i do točke


Korespondencija i memorandumiOtk 2,00 , 1. rujna 20044-10Uvod u tehničkom pisanjuUzorak pisma i dopise pojaviti na sljedećim stranicama , zajedno s predlošcima zatehničke idokumentiranje memoranduma . Ove stranice nemaju standardne zaglavlja ilipodnožja , ali nemamoBrojevi stranice .Uzorak Pismo4-1131. kolovoz 2004Velik i moćan OzKraj Yellow Brick RoadOz , CA 88888Tema : Ocjenjivanje u Prijedlogu Oz škole SitePoštovani g. Jacobs :Oz Water District (četvrt ) je pregledao revidirani ocjenjivanja i erozije planiraprimili 8. kolovoza . Također uključena jeizložba pokazuje približne granice 100 -godine poplavnom nakon postavljanja ispuniti što je predložio za projekt . Općina ima



Sljedeće napomene :1 . Kao što je objašnjeno u našem telefonskom razgovoru , promijeniti smjer toka uswale sjeverustabla teći jug do stabla području . Također , jasno ukazati na mjesto u swaleplanirati pogled .

2 . Na najjužnijem dijelu ocjenjivanja području , revidirati linije konture , tako da onislijedeporavnanje nasip služnosti prije spajanja s postojećim izohipsi .3 . Imajte na umu da jepredloženi erozije metoda postavljanja stipping materijalna novonastale padini je neprihvatljivo u Distriktu , osim ako se može dokazatida ne autohtone vrste neće biti presađeni u procesu . Prihvatljiva erozijenačini kontrole su :. Erozije PokrivačiPokrivači trebao biti instaliran u skladu s preporukama proizvođača nabi se osiguralo da deke su ravnomjerno u dodiru s tlom . Pokrivači će se sastojati odslame i / ili kokosa vlakna sadržana u roku od dva biorazgradivih neto slojeva . cijeli

proizvod mora biti biorazgradiva ; fotorazgradljivi materijali su zabranjeni . višekomercijalni izvori postoje za kupnju deke , uključujući SjevernuZelena i Greenfix Americi .b . Drvo mulchDrvo malč će biti dvostruko prizemlju drvenastog materijala kao što su drvo , grmljadodaci,ili čiste proizvodi od drveta . Štetan materijal kao što su stijene , stakla , plastike ,metala,tla grumenje , korov , sjeme korova , soli , boje, naftne derivate , pesticida ili drugihkemijskih ostataka ne smije prijeći 0,1 posto ukupnog volumena . Osamdeset i petposto iliviše neće biti veličine između 1 i 3 inča inča dugo i ne manje od3/8 do 1/ 16 inch debljine .Drvo vlage malč ne smije prelaziti 60 posto . To će biti dovoljno da bi grubaSwift infiltracija u tlo . Mulch treba ravnomjerno primijeniti na dubini od 4 do 6Pismo velike i moćne OzaFile : 17644Yellow Brick CreekRe : Oz Škola4-12Stranica 231. kolovoz 2004inča u potpunosti pokriti novokonstruirane golu padinu . Biljne trackifier može biti potrebno , ovisno o dosljednosti malč koristi .4 . Osigurati plan i presjek detalj koji pokazuje postojeći potok banku i novi Ispunitebiti postavljene na obali , a također rezultati punjenja naselja i praznih analize stabilnostikako bi se osiguralo da seispune dodatni teret ne potkopati stabilnost postojećegbanke .5 . Fill materijal mora biti ista ili ekvivalent od materijala nasipa ispune naveden napriložene specifikacije .



Osim toga , navedite kopiju onečišćenja oborinskih voda plan za sprečavanje ovogprojekta ,koje u detalje predloženih mjera protiv erozije na ovim stranicama . Ako imate bilokakvih pitanja ,molim vas da me kontaktirate na (888) 444-1212 , proširenje 12121 .

S poštovanjem ,Dorothy ŠtoIzvanredni Civil Engineer Zajednica Projekti pregled jedinicaPrilog : nasip Fill SpecifikacijeNačin isporuke: Federal Expresscc / ENC :cc :File Name oznake : 0831gUzorak Dokumentiranje Memo4-13

dizajn razvojOZ vodepredioBroj dokumenta REVIZIJA

Datum stupanja na snagu :2004/06/24Tehnički memorandumZavršni tehnički Memorandum 3.14

Arhitektonske Dizajn KriterijiPripremio : Lion , Tin šumar Datum : 23 siječnja 2004rezimeSvrha ovog dopisa je predstaviti konačnu arhitektonski dizajn za poboljšanjaOzonski struktura i za predloženi javnog gledanja hodniku u zgradi ozonskog generacijeLiječenje Oz Water Plant ( WTP ) .Dizajn osvrtom na vizualnih utjecaja poboljšanja na okolnosusjedstvu . Eksterijera završi će se uklopiti s postojećim arhitekture za proizvodnjuvizualnougodan procesne strukture .Općina koristi Oz WTP za javne ture . Gledate koridor za javnost će bitiuvjetom da se u zgradi ozonskog generacije .Za Distrikta obzir :• Odrediti površinu za organizaciju vozilo utovar i istovar smanjiti utjecaj na raddjelatnosti u pogonu .• nas obavijestiti o posebnim odredbama za vitrinama i izlošcima za gledanje hodniku .• Jeste stanarsko klasifikacije za gledanje hodniku pregledani od strane lokalne zgradeOdjel vlasti tijekom završetka gradnje dokumenata fazi .pozadinaPrvi sastanak održan je s Distrikta osoblja za ocjenu arhitektonske dizajnerske kriterije



za Ozabiljka . Općina osoblje potom posjetio postojećih objekata ozona generacije za pomoć urazvojuPostavke za dizajn novog objekta . U ozonizacije poboljšanja tehničkihmemorandum redovitom sastanku minute datirani 24. srpnja 2000 odražavaju osoblje

komentare .4-14Page 2 finale Tehnički memorandum 3.14

Arhitektonske Dizajn KriterijiOvaj trenutni rad nadograđuje već arhitektonskih studij završili po kakvoćiUredba o sukladnosti projekt . Oni su formulirani vanjska tretmani za novu ozona ikemijskih postrojenja i pridonijeli razvoju tlocrte za ovaj ozonskog generacijezgrada .

Arhitektonske i Objekt KonstruiranjeOvaj dio daje pregled određenih dizajn razmatranja napisane za svaki aspekt projekta .Javni Smještaj

Oz WTP jesamo objekt s planovima za posebne smještaj javnih ture . Tesadržaji uključuju gledanja koridor na jednom kraju zgrade ozona generacije . novilift i pristup do gledanja hodniku sastat će se onemogućiti pristup zahtjeve za javnost .Općina treba imenovati vozilo utovar i istovar područje za ture prije početkaIzgradnja priprema dokumenata .Ustanove označena kao javni pristup će biti namijenjen pristupačnosti kako je propisanozakonom .Ostali sadržaji , kao što su struktura ozona izvođača , neće biti dizajniran za javnipristup .Osnova za izradu tih područja nije za pristup je :• To su sigurnosno - ograničenim područjima nisu namijenjeni za javni pristup .• Zaposlenici obično ne zauzimaju tih područja , osim za održavanje ioperativne dužnosti .• Distrikta zaposlenici koji su fizički sposobni za obavljanje osnovne funkcijeWTP poslovi , održavanje i druge obveze povezane s tim objektima će bitifizički sposoban navigacije stepenice ili ljestve za pristup .• Fizički zahtjevi tih objekata zbog hidraulike , kemijska zatvorenost , stranicaograničenja, ili drugih sigurnosnih ili proces ograničenje ne lako primiti na - razredpristupili .Preporučujemo pregled ovog osnovi za kompatibilnost s Distrikta politika iDistriktatumačenja od svojih obveza prema trenutnom zakonu .Interijer DovršavanjeOpćina posjetio Zla vještica Zapadne WTP u West Oz i dobar vješticaEast WTP u istočnoj OZ . Općina osoblja svidjeli betonskih podova i oslikanim zidovimai suspendiranakustička stropovi ozonskog East WTP objekta . Za Oza , mi ćemo obojiti zidove istropove ,gdje je to prikladno .Pristupne VrataOpćina osoblja preferira velike čeličnih vrata s nejednakim lišća i prijenosnih transoma



ploče .To je prednost omogućujući korištenje manjih list za normalne prodora i izlazakdok jeveći list je dostupan za kretanje velike dijelove ui iz zgrade .krajobraznogPejzaž dizajn nije dio ovog djelokruga rada . Dodatni uređenje će biti dizajniran i

izgrađena od strane Distrikta kao zaseban projekt . Za smještaj budući dizajn , eksterijer hodapodručja treba omogućiti kasnije sadnje , prazne PVC cijevi rukavima treba biti pruženapodbeton za buduće navodnjavanje cjevovoda i regulacijskog ventila žica, te jedan ili višeelektričnih vodoveMožda ćete morati da se za buduće korištenje navodnjavanje kontroler ( 120 volti ) .Uzorak Dokumentiranje Memo4-15Page 3 Final Tehnički memorandum 3.14

Arhitektonske Dizajn Kriteriji

Preporuke / Zaključak / AkcijaMi smatra vizualne utjecaje Stage 2 poboljšanja u okolnim četvrtimate su dizajnirane objekte . Eksterijera završi će se uklopiti s postojećim arhitekture iproizvodnju vizualno ugodan procesne strukture . Pripremit ćemo foto- realističnegrafike za prikazPogled iz susjedne perspektive . Crteži od predloženih ozona objektima suu privitku ovog dopisa.Oz WTP će prvenstveno biti korišten od strane Distrikta za ture . Gledate koridor za

javnostosigurat će se u zgradi ozonskog generacije . Općina treba imenovati javni turnejuput za Oz , pokazujući gdje turneje vozilo utovar i istovar će se pojaviti u koordinaciji sNovi objekt dizajn .Ostali sadržaji , kao što su struktura ozona izvođača , neće biti dizajniran za javnipristup .Preporučujemo pregled ovog osnovi za kompatibilnost s Distrikta politika iDistriktatumačenja od svojih obveza prema trenutnom zakonu .Općina treba javiti ako se posebne odredbe za zaslone i eksponati želji zaGledate koridor .Stanarsko klasifikacije i gledanje hodnika izlaska bi trebao biti pregledan s lokalnomzgradeOdjel vlasti tijekom završetka gradnje dokumenata fazi .4-16IT savjetovanje ● ● treninga tehničke pisanjaMT 3468 . DIABLO ROAD Suite B105

Poštanskog Box 1018 Lafayette, CA 94.549 - 1.018 29. travnja 2004

Dokumentiranje MemoOgroman Rail automobila , Inc29 Stroj Avenue , Bldg . 4Industrijski , NY 10000Naslov : Dokument Podnošenje



Za : Mr. Morris GarretVoditelj publikacija i obukaOd : izvrstan menadžer Predmet: dostavu obrazovni program PlaRe : MBTA Bi - Razina Trener projekta , CDRL 9898

U prilogu molimo naći nacrt plana obrazovni program za pregled i komentar .To zadovoljava podnošenje zahtjeva CDRL 9898 .Ukoliko imate bilo kakvih pitanja , molimo ne ustručavajte se nazvati .Pismo br : TP - KRC - 006Tehnički memorandum o predlošku4-17društvoInfoBroj dokumenta REVIZIJA<a, b, c, etc.>Datum stupanja na snagu :

<date>Tehnički memorandum( Naziv Tehničke Memoranduma )Pripremio : ( Ime pisca ili konzultantska tvrtka )Datum : ( ili Datum poslali )rezime( Uključi svrhu dopisu i sažetak zaključaka . )pozadina( Prisjetite pozadinu ovom pitanju , jer se odnosi na ovom projektu . )Procjena pitanja( Objasnite probleme koji su uključeni i sve povezane informacije koje se odnose nadonošenje odluka ilipotrebno kako bi podržao svoje zaključke i preporuke . )Preporuke / Zaključak / Akcija( Vaše preporuke , zaključci, ili preporučene radnje koje podržava informacija u ovopodsjetnik . )4-18Ime tvrtkeMEMORANDUMNA : OD :PREDMET : DATUM :Namjena : ( prisjetite dopisa svrhu i ukratko predstaviti temu . )Rasprava : ( Raspravite i procijeniti probleme prezentirati podatke i informacije kojemogu pomoći.Čitatelj razumjeti problem i napraviti odluke vezane . Ovi podaci i informacije trebajutakođer podržavaju sve što je predstavljena u zaključcima sekciji . )Zaključak / Očekivani Akcija / Preporuke : ( Pogledajte podataka prezentiranih i prisjetite.zaključiti s konkretnim preporukama i očekivane akcije . )



___________________________ <Title>odsjekIzvještaji i studijeUvod u tehničkom pisanju 5-1

Otk 2,00 , 1. rujna 20045 . Izvještaji i studijeOvo poglavlje sadrži informacije o strukturi , elementi u , i protokdogađaja koji su uključeni u pisanom obliku složene dokumente . To predstavlja vodičza razvojsnazi nacrt za dostavljanje podataka . Poglavlje počinje s općim pravilima zaprijaviti sadržaj , s dobrim i lošim primjerima iz uzorka izvješća . poglavljezavršava popis koji pokriva osnovne organizacijske principe .Ovo poglavlje obuhvaća :

Smjernice za izvješća

pravila iskazivanja sadržaja različitih vrsta

Pravila za koherentnu protok informacija

5.1 Izvješće SmjerniceIzvješća se razlikuju po tehničkoj razini , predmet rješavati , i svrha . Sljedeće smjerniceprimjenjuju se prijaviti pisanje u cjelini . Slijedeći ove smjernice osigurava da vašeizvješćaće biti smislen i učinkovit .5.1.1 Sažetak -samostalan PoglavljeSažetak je ključni element u svakom izvješću o više od 10 stranica .sažetak služi kao samostalan dokument da je prosječna , non - tehničkihčitatelji mogu koristiti kako bi se utvrdilo ako žele pročitati izvješće . Sažetak

je čestosamo poglavlje dokumenta primatelja čitaju . Dakle ,informacijeprezentirani ovdje je ključ vrijednosti dokumenta kao cjeline . Ona objedinjujePrincip točke u dokumentu . To mora navesti svrhu ciljeva iliProblemi to rješava -sažetak nalaza , a glavni zaključci ipreporuka , ako postoje bilo . Iako je ovo poglavlje je prvi čitatelji vidjeti,trebala biti posljednja autori , jer je bitno izvući sadržaj zaSažetak na samom dokumentu . To bi trebao biti specifičan i sažeto . Jednostavanprimjer od inicijalne kazne zasažetak slijedi .Umjesto "Svrha ovog izvješća je predstaviti rezultate ipreporuka Studije u Distriktu iz Oza ".Problem : Ova rečenica je besmisleno .Koristite " Ovo izvješće prikazuje podatke o strukturni integritet XYZ Creek pomoćiOz Općina Inženjeri i projekt menadžera za procjenu troškova i prioriteteVažnost predloženog kanala popravak i zamjena rad . "Rješenje : Sada znate za kogaIzvješće je napisano , a što bi trebali učinitis njom .Izvještaji i studije--------------------------------------



NakonIzvješće je dovršeno , stvoriti sažetak vađenjeglavnatočaka iz izvješća teksta . Sažetak mora obuhvatiti sadržaj u dovoljno detaljnoodražava značenje podataka , ali to koncizno i jasno , tako da je zauzet ljudi sMalo vremena ili znanja o toj temi mogu shvatiti ključne informacije .Potrudite se zadržati sažetak što je moguće kraće . Dva do četiri stranicesu obično dovoljno za većinu tehničkih sažetak izvješća . izvršniSažetak mora biti jasan i smislen neovisno o izvješću . Stoga , nemojtepogledajte slike, tablice, ili upute sadržane i drugdje u izvješću . SažetakSama mogu sadržavati slike, tablice, ili fusnotama , dokpodaci sastavnisažetak i ključ za potporu preporuke . Budući da izvršni sažecičesto pročitati na mjestu potpuno izvješće , svim neuobičajenim simbola, kratica , iakronimi trebao biti napisane i , ako je potrebno , definirana .Nikad dodati nove podatke ili zaključke u sažetka . Svaka tvrdnja usažetak je informacija već u izvješću . Sažetak ne treba uvestiInformacije sadržane u ili nije podržan od strane izvješću , a to ne smije prelazitiDokument je djelokrug . Na primjer , ako jesvrha izvješća samo istražiti mogućealternative i prezentiranja naučenog ,sažetak ne bi trebao uključivati preporuke .Isto tako , ako jedokument koji je sažeti političku odluku , jasno se navodi da je odlukaa razlozi koji stoje iza njega , ali ne mora nužno ići u pojedinosti tog procesa izaOdluka .5.1.2 Sažetak stavciOtvaranje svakog poglavlja sa sažetkom stavka . Sažetak stavka dajePregled poglavlja u mnogo na isti načinsažetak dajePregled izvješća u cjelini . Na primjer , pogledajte prvog stavka ovog poglavlja .To objašnjava svrhu poglavlja , što sadrži , i gdje pronaćibrzoPregled informacija .Funkcija sažetka stavka je da čitatelji znaju da li pročitati ovopoglavlja ili ne , a ako žele da ga pročitate , gdje se mogu pronaći informacije kojezanimaih . Na primjer , za upravljanje samo možda želite pročitati sažetak iSažetak stavka svakog poglavlja detaljno izvješće . Iz ovog čitanja , kako bi trebalibiti u mogućnosti okupiti sve bitne točke dokumenta i pronaći ključne podatke zapodršku ,bez udubljivanja u detalje svaku temu .Dobar sažetak koristi prezent, aktiv , i jasno kaže što je upoglavlje sažima . Primjer slijedi .Umjesto " U ovom odlomku , prednosti alternativi odabran zapraćenje kvaliteta vode u Oz su sažeti . Rasprava će uključivatiPregled problema kao što smo to vidjeli , svi su predložena alternative studirao ,istraživanje o svakoj alternativi , i kako su zaključci i preporukeOpćina osoblja su postigli . "Problem : Vague i uninformative .Izvještaji i studijeUvod u tehničkom pisanju 5-3Otk 2,00 , 1. rujna 2004Koristite " Ovo odjeljku Pojedinosti preporuke Okružnog osoblja za učinkovito



praćenje kakvoće voda u Oz . Predstavljamo zadatka prva ,slijedi naše preporuke . Ostatak odjeljka predstavlja svealternative studirao , ametodologija i podupire istraživanja koristi za formiranjezaključci koji su doveli do tih preporuka . "Rješenje : informira čitatelja upravo ono što je uključen i redoslijed

prezentacije .Kao i kod sažetka , napisati sažetak odlomak poglavlja nakon štopoglavlje je potpuna . Crtanje samo o sadržaju poglavlju stvoritiSažetak .5.1.3 Glavni tijelu izvješćeTijelo izvješću je mjesto gdjeautor donosi detaljne informacije . sadržajtreba biti organizirana na sljedeći način prezentirati informacije u logičan tijek :

Uvod - pružiti pozadinu i podrijetlo studije , lokacija i

Studija ograničenja ,pregled problema ili pitanja studirao , i kako se informacijeorganizirao .

metodologija ( pristup) - Porazgovarajte o tome štostudija predlaže , štoje istražitelj

pokušava naučiti , koje podatke je potrebno i zašto . Plan rada za studij iliRasprava o sličnom istraživanju je prikladno ovdje . Dokument nikakve pretpostavke iliograničenja .

Data - Razgovarajte o nalazima , pripadajuće prikupljeni podaci ,ključni podaci o

prijaviti . Stavite podupire ili pozadinske podatke nije kritična za protok glavnog izvješćauprilozi . Referentni podaci iz drugih izvora , tako da čitatelji mogu ga pronaći.

Analiza - Dati analizu izvučeni iz podataka . Napomena nedostataka

ili neobjašnjive podataka .Zaključci - Predstavite stručno mišljenje o značenju podataka i vaš

Analize . Porazgovarajte o mogućnosti i ograničenja . ( Vidi odjeljak 5.1.4 za višeinformacija . )

Preporuke - Predstavite stručno mišljenje u pogledu djelovanja ili politike

naznačeno . ( Vidi odjeljak 5.1.5 za više informacija . )Prilozi -danas detaljni prateće informacije koje bi umanjila

protok izvješća , ali potreban je kao dodatnih informacija . ( Vidi odjeljak 5.1.6za više informacija . )Svako poglavlje ili odjeljak bi trebao teći logično od one prije . To je , prezentiratiProblem ,metoda koja se koristi za istraživanje problema , a rezultati . Zatim analiziratiPodaci , razvijaju zaključke na temelju ove analize , i , ako je potrebno , prisutnapreporuke na temelju zaključaka .Izvještaji i studijeOtk 2,00 , 1. rujna 2004 5-4Uvod u tehničkom pisanju

Ako vaš izvještaj sadrži više poglavlja podataka , prezentirati podatke , tako dačitateljmožeslijede iz početnih nalaza kroz složenije detalje . Naslov svako poglavlje jasno ,tako da čitatelji mogu lako pronaći poglavlja interesa .Česta pogreška u izvješćima je da se odnosi na slike ili tablice koje još nisuprezentirani . Podaci i prilozi moraju biti prikazani u cilju . Samo referentni pokazatelji



nakon što je uveo i objasnio , ne prije .Zaključci 5.1.4Zaključci su dizajnirani kako bi povezati glavne ideje dokumenta u svjetluDokument ciljevi . Pisci moraju izvući svoje zaključke iz podataka i analizaprikazan je u izvješću . Zaključci graditi od prikazanih podataka , oni to ne čine

predstaviti nove podatke ili se osloniti na druge izvore .Kao dio procesa izrade dokumenta, možete definirati svoje specifične namjene .Zaključci moraju biti u skladu s tom svrhom . Oni služe kao žarišteDokument ,cilj prema kojem je izvješće izrađeno . Na primjer , ako jeciljIzvješće je pružiti alternativu za vode procese postrojenja za pročišćavanje vode kako bise poboljšalaKvaliteta ,zaključak mora bitiprezentacija pojedinih alternativa . To ne trebaraspraviti estetsku vrijednost dizajna , okolno otvoreni prostor , ili planovima drugihskupinama ili udrugama .Slijediprimjer zaključak iz studije uređenja . Deklarirani ciljizvještaja je pružiti sažeti pregled projekta i alternative kako bi se smanjila

Štete od poplava potencijal . Čak i bez čitanja izvješća , ovaj zaključak sažimanalaz i predstavlja jasnu alternativu . To govori samo one pitanja važna zaProblem , i predstavlja jasan i jezgrovit zaključak , na temelju podataka i analizaprikazan je u izvješću .Postojeći poplava nosivosti Oza Creek je znatno manje od 1posto izvedba . U propusta na cesti prijelazu iJužni PacifikŽeljeznički predstavljaju značajan usko grlo u postojećem sustavu kanala .Zbog nedovoljne propusta i kanala , Oz Creek ima potencijal daPoplava više od 1.600 postojećih struktura na dubinama do 2 noge . Procijenjenapoplavaštete od 1 posto poplave su oko 21 milijuna dolara . predloženipoplava Projekt će pružiti zaštitu od 1 posto poplave , poboljšanjelokalne odvodnje , te omogućitiobjekt biti učinkovitije održavati .Projekt će koštati oko 10,9 milijuna dolara , a financirao bi se tijekom osam godina odpostoje izvori prihoda .Jedini napredak u navedenom primjeru moglo biti neka mala uređivanje :Postojeći poplava nosivosti Oza Creek je znatno manje od 1posto izvedba . U propusta na cesti prijelazu iJužni PacifikŽeljeznički predstavljaju značajna uska grla u postojećem sustavu kanala . jer neadekvatnih propusta i kanala , Oz Creek ima potencijal da poplavaoko 1.600 postojeće strukture na dubini do 2 noge . IzraženaIzvještaji i studijeUvod u tehničkom pisanju 5-5Otk 2,00 , 1. rujna 2004eliminirati štete od poplava od 1 posto poplave su oko 21 milijuna dolara .predložio poplava projekt kontrole će pružiti sljedeće pogodnosti :* Štiti od 1 posto poplava* Unaprijediti lokalnu odvodnju* Omogućilo učinkovito održavanje objektaCijena projekta je oko 10,9 milijuna dolara , a može se financirati preko osam



godine od postojećih izvora prihoda .Imajte na umu daje zaključak gore nijepreporuka . Međutim ,informacijena takav način da su koristi od predložene akcije su jasna , aPreporuka da se slijedi u izvješću ne treba Daljnju potkrijepu .5.1.5 Preporuke

Pisci često brkaju zaključke i preporuke . Zaključci susintezaod podataka prezentiranih u izvješću . Preporuke su navedene točke ili unaprijedna temelju zaključaka . Preporuke pomaknuti korak dalje zaključkupreporučiti određeni izbor ili odluku .Preporuke se samo trebao pojaviti ako su dio opsega dokumentai unutar stručnost autora . Idete izvan dosega , ili stvaranje neželjenepreporuke ili preporuke koje prelaze autorovu vidokrug , su aktivnostikoji često imaju štetne posljedice za organizaciju . To može biti točno da lineprimjerene Preporuke se pojaviti u e-mail , pisma , ili formalnog izvješća .Prije uključujući i preporuke u pisanom obliku , budite sigurni da su opravdane ,potaknuta, a uz potporu podataka . Na primjer ,studija izvedivosti može uključivati

zaključkeizvučeni iz izvješća o tome da li različiti pravci djelovanja su moguće iPreporuke na kojem alternativa nastaviti. Ove preporuke treba se usredotočitina pitanja koja imaju veze s mjerljivih ciljeva iz djelokruga rada , a ne napomoćne pitanja kao što percipiraju javnog mnijenja .Sljedeći preporuka primjeri se odnose na predloženi alternativa za pružanjerukavce olakšice stvaranjem preljevnih za Oz Creeku .Umjesto " Značajan utjecaj bioloških resursa može doći do togaalternativa . Stvarni ublažavanja uvjeti nisu poznati , ali se temelji naTeškoće identificiranje prikladnih ublažavanja mjesta za druge projektne alternative ,odgovarajuća ublažavanja za tim neizbježna bioloških učinaka ne može bitidostupni . Ovaj prijedlog je gotovo sigurno biti sporno s Gradom ,udruga za zaštitu okoliša , kao išira javnost. "Problem : Ovo je označen kao preporuku u izvješću . No to neČini se da ništa preporučiti . To ne identificiraju bilo kakve konkretne alternative , jepisani uglavnom u pasivu s uništenim fraza i riječi koje se ponavljaju , ane predstavlja jasnu izjavu o akciji željenog . Ona se ne temelji na objektivnimpodaci i zaključci .Izvještaji i studijeOtk 2,00 , 1. rujna 2004 5-6Uvod u tehničkom pisanjuKoristite " Mi ne preporučujemo predloženu alternativu rezanje preljevnih sePatka Marsh iz Oza Creeka sjeverni nasip . Munchkin Marsh je zaljev stanište ,i rijetki slatkovodna poplava iz Oza Creeku bipotencijalninegativan utjecaj na tom staništu . U najmanju ruku , ova alternativa bila potrebnaIzvješće o okolišu Utjecaj odrediti izvedivost . "Rješenje : Čak i bez čitanja prethodnom poglavlju , ova preporuka

jezgrovito sažima konkretne zaključke i predstavlja jasnu preporukuusmjerene na pitanja .Umjesto " Kako bi se osiguralo učinkovito djelovanje predloženih od poplava



mjeri i stalno ocjenjuje potrebu za uklanjanje sedimenta , krhotina ,i vegetacije ,program održavanja je potrebno . "Problem : Ova preporuka je napisan u pasivu , i ne

jasno identificirati projekt ili odrediti održavanje programa .Koristite " Na temelju povijesti poplave u Oz , East i West Oz, Oz , te

detaljni rezultati ove studije ,District of Oz smatra Studija Oz Creek područjuzahtijeva održavanje programa kako bi se uklonili opasne uvjete koji pridonoseza potencijalne poplava . Preporučujemo sljedeći program ( popis detaljipreporuka ) .Rješenje : Ova preporuka pojašnjava osnovni problem , identificiraspecifičnepodručje istraživanja , a postavlja pozornicu za detalje o planu održavanja .5.1.6 PriloziPrilozi sadrže materijale kojima se dopunjuje ili pojasni podatke iznesene uprijaviti . Iako nijeobvezni dio izvješća ,slijepo crijevo može biti korisno zaObjašnjenja koja se predugo ili složene uključiti kao fusnota ili krajnjih bilješki , ali sukorisno za čitatelja koji traže pomoć ili pojašnjenje tvrdnjama u

prijaviti . Dobro napisan izvještaj obično sadrži sve informacije potrebne da prezentirajuCilj , kako je istragom , zaključci , a ako je potrebno , preporuka .Bilo detaljni , dugotrajan prateće informacije spada u dodatku . To držidetalji od ometanja urednog prezentaciju ideja .Prilozi obično uključuju dodatne informacije ili složenu povijest projekta ,odlomci iz dokumenata i zakona koji jačaju ili ilustrira tekst , detaljne karte istolovi, pisma i druge prateće dokumente, izračuni , sirovi podaci i povijesti bolesti .Slijepo crijevo, međutim, nijeparkirno mjesto za razne bitova informacija danisu bili u mogućnosti raditi u tekstu . Svaki ulazak u dodatku treba podržatiinformacije u tekstu .Općenito , svaka Dodatak sadrži samo jednu vrstu informacija . Sadržaj svakogDodatak bi trebao biti prepoznatljiv bezčitatelju odnose na tijelu izvješće .Kadizvješće sadrži više priloga , organizirati ih u redoslijedu na kojioni se spominju u tekstu . Svaki dodatak počinje na novoj stranici , a ne poistovjećuje sNaslov opisuje njegov sadržaj . Uvodni stavak opisuje kontekstDodatak je često korisno .Izvještaji i studijeUvod u tehničkom pisanju 5-7Otk 2,00 , 1. rujna 2004Naslovi 5.1.7Naslovi u dokumentu su poput prometnih znakova na autocesti . Odaberite kratka ,opisnoNaslovi kako bi čitatelji lako kretanje kroz dokument . Tipično , naslovipojaviti u istoj razini lijevo , serazlikuje od fonta teksta , te su veći i podebljana .Odgovarajući naslovi čitateljima pomoći da brzo skeniranje kroz dokument kako bipronašli ono što im jepotrebno . Međutim , naslovi nisu proizvoljne biljezi . Oni slijede osnovna pravila ,uključujući :

Naslovi slijediti standardna pravila za kapitalizaciju od naslova .

Najmanje jedna rečenica teksta trebao bi se pojaviti ispod naslova koji opisuje što



Pojmom pokriva . Na primjer , nemaju praznih naslova oznakom zaključke ,onda odmahpodnaslov oznakom Zaključak 1 . Sažeti onoZaključci sadrže s najmanje jednoj rečenici teksta , a zatim predstaviti pojedincaZaključci ispod podnaslova .

subheads uvijek mora biti u skupinama od dva ili više . Ako nemate tekst za

određeni tarifni broj , ili manje od dva podnaslova , kombinirati podatkeeliminirati potrebu za naslove za temu . Na primjer , u ovom poglavlju , 5.1 jenaslova , a kroz 5.1.8 5.1.1 su podnaslovi .

Ne alineje naslove za izvješća . Ostavljajući ih ostavili opravdano čini ih lako

skeniranje .5.1.8 Referentni informacijeSpominjanje podataka su važni u tehničkim dokumentima . Međutim , pisci trebali samoodnose se na informacije koje su predstavljene prije . Ne odnose se na stolu koji sepojavljuje uSljedeće poglavlje . Prezentaciju informacija u logičkom slijedu , tako dapodupirePodaci se s rasprave . Nakon toga možete uputiti natrag na njega , ako je potrebno ,

kako bipojačali zaključak . Grafikoni i grafika koje objašnjavaju tekst bi se trebao pojaviti stekstom naista stranica iliokrenuti stranicu , ako je moguće . Detaljne tablice i složene tehničkeInformacije obično spadaju u dodatku . U ovom slučaju , odnose se na dodatku kadaPrvi definirati informacije koje podržava i , po potrebi , kao što ste istražiti temu .5.2 SažetakJasno i logično predstavljanje informacija je ključ za prijenos znanja načitatelj . Strukturiranje točke u logičan slijed bi trebao bitiprvi korak u pripremiprijaviti . Sljedeće stranice daju popis .Izvještaji i studijeCOtk 2,00 , 1. rujna 2004 5-8Uvod u tehničkom pisanjuPopis za provjeru 5 -izvješća i studijePublika i namjena

jasno definira pojedince koji bi trebao pročitati ovaj dokument .

Pokazuje to publika konkretno štodokument će im pomognu .

Koristi riječi mogu razumjeti .

SažetakJesamostalan dokument koji prosjek, ne- tehnički čitatelji mogu koristiti kako bi se

utvrdiložele li pročitao izvješće .

Sadržaj se izvući iz izvještaja i ne referentno ništa izvan izvješću .

državama cilj u izvješću .

Sažima ključne točke u izvješću .

države zaključke ili preporuke izvješća .

suzdrži od osobnih mišljenja ( odnosi se na cijeli izvještaj ) .

Presents zaključci ili preporuke koje su u nadležnosti

Organizacija ( odnosi se na cijeli izvještaj ) .



Nije više od četiri stranice .

Prijavi tijeloZapisano u prezent, aktivnog glasa .

Svako poglavlje počinje sa sažetkom stavka koja pruža pregled

poglavlje .

sadržaj slijedi logičan redoslijed : cilj, metodologija , podataka , analize , zaključci,

preporuke .prateći materijal se nalazi u dodacima , a ne u tijelu izvješće .

Podaci se spominje tek nakon što ga je podnijela .

Pravilno interpunkcije i gramatike koristi tijekom .

kratak, opisni naslovi pomoći čitateljima kretati lako kroz dokument .

Stručni ton održava tijekom .

Izvještaji i studijeUvod u tehničkom pisanju 5-9Otk 2,00 , 1. rujna 2004zaključak

izgradnje iz podataka .

Ne predstaviti nove podatke ili se osloniti na druge izvore .

predstavila mišljenja izvući iz analize podataka , tako da čitatelj može lako

odrediti najbolji način djelovanja .nije izričito preporučila radnju

.Preporuke

se samo ako su prikladne za ovo izvješće .

Predložite politiku ili tijekom akcije na temelju zaključaka .

Jasno sažeti zaključak na kojem se temelji .

su u nadležnosti i stručnosti autora .

Dokument Kontrolni popisUvod u tehničkom pisanju B - 1Otk 2,00 , 1. rujna 2004Dodatak A. RječnikOvaj pojmovnik služi kao primjer terminologiji često se koristi u vodenim sustavimadaljinskog izvješćima . tone predstavlja pojmove koji se koriste u ovom dokumentu . Čini se kao dvije straniceprimjeru formatui razina informacijapojmovnik treba pružiti .

ABA Arhitektonskih barijera djelovati ACMartikulirane betonske madracaral -noga ( af )Količina vode da bi pokrivaju ral do dubine od jedne noge , što je jednako oko325.000 galona vode .ad valorem porezaPorez na temelju vrijednosti nekretnine .



ADA Amerikanci s invaliditetom Act ADTProsječni dnevni prometaggradation

Geološki proces kojim streambeds i poplavnim nizinama su odrasli u visini odtaloženje materijala ugrožena i prevezli iz drugih područja . Suprotnostdegradacije .aluvialniKoji se odnose na materijal ili procese vezane uz prijevoz i / ili subaerialtaloženje strane koncentriranog tekućom vodom .okolniPostojeći ili pozadina ( npr. , uvjeti okoline ) . Obično se koristi za opisivanje postojećezrak, tlo , vodu , ili stanišne uvjete u određenom području . Bilo unconfined dio

Atmosfera ( odnosno , izvan ) .armatura ( hidrologija )

Primjena različitih materijala kako bi zaštitili tok banke od erozije .amortizacijaProces likvidacije duga na rate plaćanja ili plaćanje u potonuća fonda ;na proporcionalni tijekom određenog razdoblja na određeno kamatne stope .Dokument Kontrolni popisOtk 2,00 , 1. rujna 2004 B - 2Uvod u tehničkom pisanjuanadromnihRiba koja se seli iz slane vode na mrijest u slatkoj , kao što su losos od rodovaSalmo i Oncorhynchus .aquicludeTijelo stijene koja upija vodu polako , ali ne dovoljno brzo da ga prenijeti za opskrbudobro ili proljeće .vodonosnikTijelo stijena ili formacija koja je dovoljno propusna za obavljanje podzemnih voda iprinosa gospodarski značajne količine vode na bunarima i izvorima .aquitardZasićena , ali slabo propusni sloj koji usporava , ali ne sprečava protokvode ili iz susjedne vodonosnika.zglobni betonski blokovi ( ACB )Male , međusobno isprepliću , gotovi betonski blokovi vezani zajedno u prostirci svisoke čvrstoćepoliestera kabeli . Koristi se za zaštitu erozije na potok banaka i preokreće . Dostupan srupe za vegetativni rast i perkolacije kroz blokove .atraktivna smetnjuNešto da poziva ljude u opasne situacije .- Ponderirana razina zvuka ( dBA )Razina buke na kojeponderirana skala je primijenjena . Ponderirana skalaaproksimira frekvencijski odziv ljudsko uho ponderiranjem frekvencijskom rasponuod 1.000 do 5.000 herca jače od drugih frekvencija . ( Neponderiranim razine buke



izraženi u jedinici dB . ) Moguće je izmjeriti A-vrednovana razina buke pomoćuInstrument s "A " filter .banke erozijeUklanjanje nanosa i čestica tla iz banke , ponajprije tekućom vodom . Klima ,ice , krhotine , kemijske reakcije , promjene u korištenju zemljišta i stream također mogu

pridonijetibanke erozije .bankfull iscjedakBankfull iscjedak ili kanala - forming iscjedak je jedan iscjedak protuvrijednosti u svojemutjecati na raspon od pražnjenja koje uređuju oblik i veličinu kanalu .stabilizaciju banaka strukturaZnačajka instaliran ili izgrađena za smanjenje bankovni erozije .bar Depozit od sedimenta ( gromada , šljunak, pijesak i blato , na krevetu od potoka ) ,običnoformirati i mijenjati po visokog vodostaja i izložena u slučaju nestašice vode .

Dokument Kontrolni popisUvod u tehničkom pisanju B - 1Otk 2,00 , 1. rujna 2004Dodatak B. Dokument Kontrolni popisDokument Title_______________

Author______________________ Publika i namjena

jasno definira pojedince koji bi trebao pročitati ovaj dokument .

govori štodokument će vam pomoćinapraviti publiku .

koristi riječi čitatelji mogu razumjeti .

PismaPrati standardni format .

počinje s uvodnom paragrafu koji jasno navodi svrhu pismu .

Pruža logičkih , podržava odlomke za tijelo u pismu .

Sažima ključne točke u završnom stavku .

razgovarao samo stavke u nadležnosti organizacije .

suzdrži od osobnih mišljenja .

Održava profesionalni ton cijeloj .

E-mailUtvrđuje temu ove e-mail (nijeprethodni ) u liniji .

Održava sadržaja kratka i do točke ( jedan zaslon informacija , ako je moguće ) .

Koristi odgovarajuće interpunkcije i gramatiku .

razgovarao samo stavke u nadležnosti organizacije .

suzdrži od osobnih mišljenja .


memorandumiPrati standardni format .

Sažima ključne točke u početnoj točki .

Održava sadržaja kratka i do točke .




Dokument Kontrolni popisOtk 2,00 , 1. rujna 2004 B - 2Uvod u tehničkom pisanjuIzvještaji i studijeSažetak

Jesamostalan dokument koji prosjek, ne- tehnički čitatelji mogu koristiti kako bi se

utvrdiložele li pročitao izvješće .

Sadržaj se izvući iz izvještaja i ne referentno ništa izvan izvješću .

državama cilj u izvješću .

Sažima ključne točke u izvješću .

države zaključke ili preporuke izvješća .

suzdrži od osobnih mišljenja ( odnosi se na cijeli izvještaj ) .

Presents zaključci ili preporuke koje su u nadležnosti

Organizacija ( odnosi se na cijeli izvještaj ) .Nije više od četiri stranice .

Prijavi tijeloZapisano u prezent, aktivnog glasa .

Svako poglavlje počinje sa sažetkom stavka koja pruža pregled

poglavlje .sadržaj slijedi logičan redoslijed : cilj, metodologija , podataka , analize , zaključci,

preporuke .prateći materijal se nalazi u dodacima , a ne u tijelu izvješće .

Podaci se spominje tek nakon što ga je podnijela .

Pravilno interpunkcije i gramatike koristi tijekom .

kratak, opisni naslovi pomoći čitateljima kretati lako kroz dokument .

Stručni ton održava tijekom .

Zaključciizgradnje iz podataka .

Ne predstaviti nove podatke ili se osloniti na druge izvore .

predstavila mišljenja izvući iz analize podataka , tako da čitatelj može lako

odrediti najbolji način djelovanja .nije izričito preporučila radnju .

PreporukeSamo se po potrebi za ovo izvješće .

Preporučuje politiku ili tijekom akcije na temelju zaključaka .

jasno sažima zaključak na kojem se temelji .

su u nadležnosti i stručnosti autora .

Dokument Kontrolni popisUvod u tehničkom pisanju B - 3Otk 2,00 , 1. rujna 2004etika

Jezik jasno kaže tko je za što odgovoran .

Ispravno predstavlja sve podatke

Oštre jezik to uopće moglo dovesti u zabludu čitatelje .

Pruža ispravan naglasak na temelju podataka .



Tretira stavove drugih pošteno i profesionalno .

jasno navodi sve izvore koji se koriste za pisanje izvješća .

Svaka alternativa je predstavljen na jasan i nepristran način .

Sve preporuke i zaključci su podržani od strane činjenične informacije izneseni u

prijaviti .

Svi sudovi , preporuke, ili komentari su u okviru projekta ili

organizacije charter .priznali i dobili dozvolu za korištenje autorskim pravima informacije koristiti u izvješću .

Sav materijal je bitno za ovaj projekt .

Provjereno dokument za komentare koji bi mogli biti pogrešno shvaćena ili izazvati

sukob uorganizacije ili između organizacija .Dokument Kontrolni popisOtk 2,00 , 1. rujna 2004 B - 4Uvod u tehničkom pisanjumontaža

Provjereno za prezent, aktivnog glasa .

Provjereno za suvišnih riječi .

Koristi rodno neutralna formulacija .

Akronimi i kratice definirane pri prvom spominjanju .

Provjereno za temu / glagol sporazum .

korištenih kratica i ostale terminologije dosljedno .

Provjereno pogrešno napisane riječi ( nemojte se oslanjati isključivo na provjeru

pravopisa ) .Provjereno za pravilnu uporabu interpunkcije .

Slike i tablice numeriraju , a pojavljuje se u ispravnom položaju .

popratna dokumentacija nalazi se dodacima .

slike , tablice, i prilozi iz točno.

grafičkim oznakama i numerirane popise imaju paralelnu gradnju i dosljedan

interpunkcije .razine naslova slijede sekvencijalno . Ako ste stvorili jednu podnaslovu , morate imati

najmanje dva .Na primjer , ne stvaraju naslova 1.1.1 beznaslova 1.1.2 . Ako podatke za samo jednupodnaslovu postoji, sve to bi se trebao pojaviti u glavni naslov , 1.1 .

Paginacija točna ( na primjer , ako su dijelovi brojevima 1 -X, 2 - x , itd. , svako

poglavlje počinjena stranici x-1 ) .

Rječnik identificira sve ključne pojmove .

Updated i ovjeren TOC i indeks unose .

Naslov stranica navodi naslov, autore , volumen broj, datum .

prilogu znak - off list s komentarima i datum revizije su zbog .

Pregledao sam priloženi dokument s promjenama kao što je navedeno u pisanomobliku .Potpis potvrđuje odobrenje da se uključi komentare i nastavite sa sljedećem nacrtu .

________________________________ Ime recenzenta



____________________________ datumpredložena resursiUvod u tehničkom pisanju C - 1Otk 2,00 , 1. rujna 2004

Dodatak C. Preporučena ResourcesOve knjige čine izvrsnu Biblioteka tehničke pisanja . Oni su jednostavnočitati i vrlo pristupačan svima zainteresiranim da postanebolji pisac . miPosebno preporučujemo priručnika Tehničke pisanja i vizualni prikazKvantitativna informacije .Chicago Manual of Style14. izdanje . University of Chicago Press , 1993Reperna za objavljenog materijala .Obrtni Znanstvenog Pisanje

Alley , Michael . Treće izdanje . Springer Verlag - 1996 .Jednostavan za čitanje , sveobuhvatnu raspravu o tome što ide u znanstvenom izvješću

.Elementi stilaStrunk , William , Jr. , i E.B. Bijela . Treće izdanje . Školska knjiga, Bacon , 1979 .Svatko tko piše ništa trebao pročitati ovu knjižicu . To je dobro napisano , lako čitati ,i prepuna osnove .Elementi Tehničke PisanjeBlake , Gary i Robert W. Bly . Macmillan Publishing Company , 1993 .Zapisano u istom stilu kao 'Elementi stila .informacije EnvisioningTufte , Edward R. Grafika Press , 1990 .Jedna od dvije izvrsne knjige ovog autora na korištenje grafikona kako bi se poboljšalatehničke informacije.Priručnik Non - seksistički PisanjeMiller , Casey . Barnes i dobitnik Nobelove Books , 1981 .Dobar pregled kako bi se izbjeglo rodno - specifične probleme u tehničkoj pisanomobliku .predložena resursiOtk 2,00 , 1. rujna 2004 C - 2Uvod u tehničkom pisanjuPriručnik za tehničke Pisanje

Alred , Gerald J. , Charles T. Brusaw , i Walter E. Oliu . Martinje Press , 2000 .Poznati referenca na terenu i visoko preporučeno .Harbrace College PriručnikHarcourt Brace & Company , 1994 .Standardna faksu gramatiku teksta , mali i zgodan za brzo adresiranje .Grijeh i SintaksaHale , Constance . Broadway Books , 1999 .Jednostavan za čitanje knjiga koja koristi literaturu i humora da nas prosvijetliti ogramatici ikorištenja .



Visual Display kvantitativnih podatakaTufte , Edward R. Grafika Press , 2001 .Naš osobni favorit dvije izvrsne knjige ovog autora na korištenje grafikona i grafova dapoboljšanje tehničke informacije .bibliografija

Uvod u tehničkom pisanju C - 3Otk 2,00 , 1. rujna 2004bibliografija

Alley , Michael . Obrtni znanstvenog pisanja . 3. izdanje . New York : Springer Verlag - .1996 .

Alred , Gerald J. , Charles T. Brusaw , i Walter E. Oliu . Priručnik za tehničke pisanja .6. ed . Boston : Bedford / St . Martins . 2000 .Blake , Gary i Robert W. Bly . Elementi Tehničke pisanja. New York :Macmillan Publishing Company . 1993 .Chicago Manual of Style . 14. ed . Chicago : University of Chicago Press . 1993 .Etički kodeks za inženjere . Nacionalno društvo profesionalnih inženjera .

Standarda profesionalnog ponašanja za inženjera . American Society of Civil

Documents

TechProse je tehničko pisanje