Prosím, kliknite sem, aby ste pomohli. David McMurrey zaplatí svoj účet za webhosting:
Darujte akúkoľvek malú sumu, ktorú môžete!
Online technické písanie zostane zadarmo.
Veľká zmena nastala v tejto online knihe o technickom písaní: teraz používa technická dokumentácia (technická dokumentácia na krátko) na označenie akéhokoľvek dokumentu, ktorý obsahuje technické informácie—na rozdiel od používania správa. Správa je podkategória spolu s ostatnými druhmi technických dokumentov diskutovaných v tejto knihe.
Poznámka: Tento učebnica technického písania sa zameriava na technické písanie rôchskill. Technický obsah uvedený tu nie je zaručený ako presný alebo aktuálny.
Úvod: Technické písanie
Aplikácie technického písania
Poznámka: Tento online učebnica teraz používa technická dokumentácia, alebo len techdoc, v prípadoch, keď správa je príliš špecifické. (emblémy OSN) naznačujú, že preklady sú k dispozícii, ak kliknete na odkaz.
- Obchodné a pracovné dokumenty:
- Prieskum techdocs
- Dátové správy
- Obchodné plány
- Návrhy
- Hlášenia o pokroku
- Pokyny
- Technické správy (techdocs)
- Literárne recenzie
- Správa o inžinierskom návrhu
- Biele knihy
- Technológicky orientované používateľské príručky
- Príručky a dokumenty s usmerneniami
- Štandardné operačné politiky a postupy
- Odporúčania a správy o vykonateľnosti
- Príručky
- Predná a zadná časť materiálu:
- Ústne prezentácie
Informačné štruktúry
Informačné štruktúry sa používajú ako súčasti dlhších dokumentov, ale môžu byť použité aj ako samostatné dokumenty, najmä pre projekty technického písania. Tieto informačné štruktúry sú dobrým miestom na začiatok pre ľudí v oblasti vývojového technického písania.
Dizajn dokumentu
- Návrh technickej dokumentácie prehľad
- Prehľad dizajnu knihy
- Prehľad dizajnu stránky
- Nadpisy
- Zoznamy
- Špeciálne oznámenia
- Nekontextualne: tabuľky, obrázky, grafy
- Formát Techdoc a konečné balenie
- Zvýraznenie a dôraz
- Indexovanie
Procesy a smernice v technickom písaní
- Písací proces: od publika k hrubej verzii
- Analýza publika
- Analýza úloh
- Preklad technických informácií
- Techniky na revíziu výkonu
- Knižnice, dokumentácia, krížové odkazy
- Zber informácií (NoodleTools alebo Notebook LM)
- Citáty, Parafrázy, Zhrnutia: Formulácie, Interpunkcia, Priradenie
- Základné vzory a prvky vety
- Bežné problémy s gramatikou, používaním a interpunkciou
- Bežné problémy s pravopisom
- Stratégie pre hodnotenie od kolegov a písanie v tíme
- Odkazy na referenčné dielo
Príklady, Prípady a Modely: Index
- Životopisy
- Žiadosti o zamestnanie
- Reklamačné listy
- Úpravy písmen
- Dopytové listy
- Objednať písmená
- Návrhy
- Správy o pokroku
- Pokyny
- Používateľské príručky
- Odporúčacie správy
- Správy o analýze dát
- Technické správy (techdocs)
- Primárne výskumné správy
- Technické špecifikácie
- Ústne správy
- Správy a úvody do sekcií
- Popisy
- Porovnania
- Klasifikácia (Kategorizácia)
- Príčinný naratív
- Definície
- Spracovanie naratívu
- Presvedčenie
