Kérjük, kattints ide, hogy segíts David McMurrey-nek kifizetni a webtárhely díját:
Adományozz bármilyen kis összeget, amit megengedhetsz magadnak!
Az Online Technical Writing továbbra is ingyenes marad.
Jelentős változás történt ebben az online műszaki írásról szóló könyvben: mostantól a technical document (techdoc röviden) kifejezést használja minden olyan dokumentum megnevezésére, amely műszaki információkat tartalmaz — a report kifejezés helyett. A jelentés (report) egy alkategória a könyvben tárgyalt egyéb műszaki dokumentumtípusok mellett.
Megjegyzés: Ez a műszaki írásról szóló tankönyv a műszaki írás készségeire összpontosít. Az itt szereplő műszaki tartalom pontossága és aktualitása nem garantált.
Bevezetés: Műszaki írás
- Mi az újdonság?
- A műszaki írásról
- A műszaki írás tanfolyamairól
- Források
- A szerzőről
- Köszönetnyilvánítás
A műszaki írás alkalmazásai
Megjegyzés: Ez az online tankönyv mostantól a technical document, illetve techdoc kifejezést használja azokban az esetekben, amikor a report túlzottan specifikus. A
(UN emblémák) azt jelzik, hogy a hivatkozás megnyitásával fordítások érhetők el.
- Üzleti és foglalkoztatási dokumentumok:
- A techdocok típusai: áttekintés
- Adatjelentések

- Üzleti tervek
- Javaslatok

- Előrehaladási jelentések
- Utasítások
- Műszaki jelentések (techdocs)
- Fehér könyvek (White papers)
- Számítógépes felhasználói útmutatók
- Útmutatók és iránymutató dokumentumok
- Szabványos működési irányelvek és eljárások
- Ajánlási és megvalósíthatósági jelentések
- Kézikönyvek
- Címek, címlapok, kivonatok, bevezetések és következtetések
- Szóbeli prezentációk
Információs struktúrák
Az információs struktúrákat hosszabb dokumentumok részeként használják, de önálló dokumentumként is alkalmazhatók, különösen műszaki írással (technical writing) kapcsolatos projektek esetében.
Dokumentumtervezés
- A techdoc tervezésének áttekintése
- A könyvtervezés áttekintése
- Az oldaltervezés áttekintése
- Címsorok
- Listák
- Különleges megjegyzések
- Nem szöveges elemek: táblázatok, ábrák, diagramok
- A techdoc formátuma és végső összeállítása
- Kiemelés és hangsúlyozás
- Indexelés
Folyamatok és irányelvek a műszaki írásban
- Az írás folyamata: a célközönségtől az első vázlatig
- Célközönség-elemzés
- Feladatelemzés
- Műszaki információk fordítása
- Hatékony átdolgozási technikák
- Könyvtárak, dokumentáció és kereszthivatkozások
- Információgyűjtés (NoodleTools vagy Notebook LM)
- Idézetek, parafrázisok és összefoglalók: Megfogalmazás, írásjelek és forrásmegjelölés
- A mondat alapvető mintái és elemei
- Gyakori nyelvtani, nyelvhasználati és írásjel-hibák
- Gyakori helyesírási problémák
- Stratégiák a szakmai lektoráláshoz és a csoportos íráshoz
Példák, esetek és modellek: mutató
- Önéletrajzok
- Pályázati levelek
- Panaszlevelek
- Korrekciós levelek
- Érdeklődő levelek
- Megrendelő levelek
- Javaslatok
- Előrehaladási jelentések
- Utasítások
- Felhasználói útmutatók
- Ajánlási jelentések
- Adatfeldolgozási jelentések
- Műszaki jelentések (techdocs)
- Elsődleges kutatási jelentések
- Műszaki specifikációk
- Szóbeli jelentések
- Jelentések és szakaszok bevezetései
- Leírások
- Összehasonlítások
- Osztályozás (Classification / Categorization)
- Ok-okozati leírás
- Meghatározások
- Folyamatleírás
- Meggyőzés (Persuasion)
