Pisanje tehničke i projektne dokumentacije
Vi ste profesionalac na polju tehnike, možda programer, inženjer ili naučnik. Niste profesionalni pisac, ali je pisanje sastavni deo vašeg posla (specifikacije, uputstva, poslovne ponude, laboratorijski izveštaji, tehničke prezentacije, Web sadržaj, tabelarni obrasci, i tako dalje). Dobro došli. Ovo je knjiga za vas. Sve što vam je potrebno da jasno prenesete svoje tehničke ideje bilo kojoj čitalačkoj publici, tehnički obrazovanoj ili ne, i da je podstaknete na delovanje. Potrebna su vam konkretna rešenja? Odmah ćete ih pronaći u ovoj maloj knjizi, koju odlikuje veoma efikasno vizuelno uređenje.
Zaronite, počnite da učite i brzo postignite željene rezultate!
* Učinite sve svoje dokumente i prezentacije preglednijim, konciznijim i privlačnijim
* Shvatite potrebe svojih čitalaca i usmerite sadržaj na odgovarajući način
* Naučite kako da pišete za čitaoce iz celog sveta
* Koristite aktivne rečenice za pouzdanu i ubedljivu komunikaciju
* Kreirajte efikasne liste, tabele i grafikone
* Kreirajte korisne primere
* Pišite efikasna uputstva i napomene uz nova izdanja
* Postavite pouzdane tehničke Web sajtove
* Napišite najbolje istraživačke i poslovne ponude i predloge za knjige
* Kreirajte i predstavite privlačne PowerPoint prezentacije
* Pišite e-mail poruke koje neće izazvati polemike
* Naučite kako da integrišete pisanje dokumentacije sa najboljim primerima iz inženjerske prakse
* Neke primere je moguće preuzeti sa Weba.
O autoru
Barry J. Rosenberg organizuje sve aspekte efikasnog pisanja tehničke dokumentacije u više od 175 kratkih, konciznih tutorijala. Pronaći ćete brojne primere (šta treba i šta ne treba raditi), plus kompletne instrukcije za pisanje odgovarajuće vrste dokumenata u skladu sa vašim potrebama.
Skok u je nova edicija kratkih, konciznih tutorijala objavljenih od strane izdavačke kuće Addison-Wesley. Svaka knjiga u ediciji ima zadatak da vas brzo "postavi na noge." Složene teme i tehnologije svedene su na svoje osnovne komponente, a svaka komponenta se obrađuje sa neverovatnom efikasnošću na svega jednoj ili dve stranice. Predstavljene su samo informacije koje su neophodne za početak rada...odmah! Pošto su knjige bogate primerima i lako se pretražuju, uvidećete da su sjajni priručnici nakon što savladate osnove.
Kratak sadržaj
1 DEO, Planiranje
POGLAVLJE 1, Traganje
Teoreme tehničkog pisanja
Pisanje tehničke dokumentacije može biti kreativno
Kažite im
Značaj veštine komuniciranja
Poređenje načina pisanja tehničke dokumentacije za potrebe inženjera i naučnika
POGLAVLJE 2, Čitaoci
Nivo opšteg obrazovanja
Stručnost i ekspertiza
Brojnost čitalaca
Maternji jezik
Kulturne razlike
Motivisanje čitalaca
Medijum i poruka
Zamislite da ste čitalac
Zaključak
POGLAVLJE 3, Planiranje dokumentacije
Specifikacije dokumenata
Specifikacija dokumenta: Primer
Projektni planovi pisanja dokumentacije
Plan pisanja dokumentacije: Primer
Zaključak
2 DEO, Pisanje: Opšti principi
POGLAVLJE, 4 Reči
Žargon
Konzistentnost
Glagoli
Pridevi i prilozi
Zamenice: He (on), She (ona), i They (oni)
Zamenice: You (Vi)
Zamenice: It (ono) i They (oni)
Beskorisne fraze
Najčešće pogrešno upotrebljavane reči
Zaključak
POGLAVLJE 5, Rečenice
Aktivni i pasivni glagolski oblik
Aktivni glagolski oblik je bolji
Kada je prikladno koristiti pasivni oblik?
Kratko je slatko
Razlozi za dugačke rečenice
Jedna rečenica = Jedna misao
Umetnute rečenice
Zaključak
POGLAVLJE 6, Pasusi i odlomci
Prelazi između rečenica
Dužina pasusa
Prelazi između pasusa
Odlomci
Zaključak
POGLAVLJE, 7 Liste
Liste nabrajanja
Elementi u listama nabrajanja
Dužina svakog elementa
Numerisane liste
Smernice
Uvodi u liste
Paralelne liste
Zaključak
POGLAVLJE 8, Tabele
Zaglavlja kolona
Merne jedinice
Uređenje kolona i redova
Paralelizam u tabelama
Količina teksta u ćelijama
Linije razdvajanja
Senčenje
Naslovi
Zaključak
POGLAVLJE 9, Grafički elementi
Vremenski grafikoni
Dodatni detalji na onlajn grafikonima
Pre i posle
Povezani naspram umetnutog teksta
Grafikoni koji orijentišu čitaoce
Snimci ekrana (screenshots)
Daltonizam
Blok dijagrami
Tekst koji dopunjava slike
Tehnička fotografija
Isticanje detalja na tehničkim fotografijama
Najpre šira slika, zatim detalji
Raspored elemenata: Kontrolisanje fokusa
Raspored elemenata: Zadržavanje pažnje na stranici
Raspored elemenata: Prazan prostor
Zaključak
POGLAVLJE 10, Tajne profesionalaca
Objašnjavanje zakona zasnovanih na formulama
Primeri
Davanje primera pomoću metafora
Primeri za dokumentovanje programskog koda
Primer u formatu Pitanje-Odgovor
Primer formata Pitanje-Odgovor
Drugim rečima
Ton
Tempo
Fusnote i druge digresije
Više od očiglednog
Precizni opisi
Najteži deo pisanja
Zaključak
3 DEO, Pisanje: Vrste dokumenata
POGLAVLJE 11, Uputstva
Vrsta uputstva: Princip kuvara
Primer uputstva po principu kuvara: Instaliranje Carambola Servera
Vrsta uputstva: Tutorijali
Primer tutorijala: Upoznavanje sa HTML-om
Vrsta uputstva: Vodiči
Primer vodiča: Kreiranje HTML zaglavlja
Vrsta uputstva: Uputstva sa referencama
Primer referenci: Pomoćna rutina pr1me
Vrsta uputstva: Neverbalna uputstva
Online Help: Pregled
Online Help: Najbolji pristupi
Primeri Online Helpa
Napomene uz nova izdanja
Primer napomena uz nova izdanja: Carambola Web Server Version 3.7
Predgovori
Primer predgovora
Rečnici pojmova
Primer rečnika pojmova: Termini vezani za tropsku klimu
Sadržaji
Indeksi
Indeksi: Obezbeđivanje konciznih zapisa
Indeksi: Permutovanje termina
Indeksi: Obezbeđivanje zapisa za koncepte
Zaključak
POGLAVLJE 12, Web sajtovi
Planiranje
Početna stranica: Navedite svrhu i cilju grupu posetilaca
Početne stranice: Podstaknite čitaočevu maštu
Početne stranice: Postavite ton
Šabloni za pravljenje stranica
Navigatori i polja za pretragu
Hiperlinkovi u glavnom tekstu
Sekundarne stranice
Tekst na web sajtovima
Najčešće postavljana pitanja (FAQs)
Zaključak
POGLAVLJE 13, Ponude
Ponuda pre ponude
Pridržavajte se šablona za pisanje ponuda
Element ponude: Propratna pisma
Element ponude: Biografije
Element ponude: Rezimei
Element ponude: Rezervni planovi
Ponude za revolucionarne ideje
Ponude za izvođenje istraživanja
Ponude za izvođenje istraživanja: Iskaz o značaju istraživanja
Ponude za izvođenje istraživanja: Ciljevi i hipoteze
Ponude za izvođenje istraživanja: Dizajn i metodi
Ponude za pisanje knjiga
Ponuda za pisanje knjige: Primer odlomka posvećenog marketingu
Biznis planovi
Zaključak
POGLAVLJE 14, Interni dokumenti za planiranje
Poslovne ponude
Poslovna ponuda: Primer
Tehničke specifikacije visokog nivoa
Primer tehničke specifikacije visokog nivoa
Tehničke specifikacije niskog nivoa
Primer tehničke specifikacije niskog nivoa
Zaključak
POGLAVLJE 15, Laboratorijski izveštaji
Rezime
Uvod
Materijali
Eksperimentalni postupak
Rezultati
Diskusija
Zaključak
Reference
Zaključak
POGLAVLJE 16, PowerPoint prezentacije
Organizovanje prezentacije: Kompletna slika
Broj slajdova
Uvodni momenti prezentacije
Uvodni slajdovi: Tradicionalni pristup
Uvodni slajdovi: Alternativni pristup
Glavni slajdovi: Tempo i raznolikost
Mehanički elementi: Fontovi i pozadine
Glavni slajdovi: Efikasne liste
Publika: Teorija relativiteta
Grafikoni
Složenost grafikona
Deo za postavljanje pitanja
Različiti načini učenja
PowerPoint govor: Osnove
PowerPoint govor: Lekcije profesionalaca
PowerPoint govor: Prevazilaženje straha
Zaključak
POGLAVLJE 17, E-Mail
Suštinski problem kod pisanja e-maila
Pre nego što pritisnete dugme Sent
Nakon prvog nesporazuma u komunikaciji
Zaključak
4 DEO, Recenziranje i kreiranje konačne verzije dokumenata
POGLAVLJE 18, Recenziranje i lektorisanje dokumentacije
Recenziranje: Šta u stvari podrazumeva?
Recenziranje koleginog rada
Recenziranje rada kog je napisao vaš nadređeni
Lektorisanje koleginog dokumenta
Lektorisanje sopstvenog dokumenta
Medijum za recenziranje
Sistemi za praćenje grešaka
Proces lektorisanja
Beta testovi za dokumentaciju
Zaključak
POGLAVLJE 19, Fontovi i tipografija
Fontovi Serif i Sans Serif
Fontovi fiksne širine naspram fontova promenljive širine
Serif i Sans-Serif na štampanim kopijama
Serif i Sans-Serif u elektronskim kopijama
Visina fonta
Kurzivi i podebljani tekst
Konzistentnost i konvencija
True-Type naspram PostScript fontova
Zaključak
POGLAVLJE 20, Interpunkcija
Zarezi
Povlake i crtice
Tačka zarezi
Tačke
Dvotačke
Navodnici
Rečnik pojmova
Bibliografija
Indeks
Detaljni podaci o knjiziNaslov: Pisanje tehničke i projektne dokumentacije
Izdavač: Kompjuter biblioteka
Strana: 352 (cb)
Povez: meki
Pismo:
Format: 24 cm
Godina izdanja: 2006
ISBN: 86-7310-359-2