Kérlek, kattints ide a segítségért. David McMurrey fizesse ki a webtárhely díját:
Adományozz bármilyen kis összeget, amit tudsz!
Az online technikai írás továbbra is ingyenes marad.
Nagy változás történt ebben az online műszaki írás könyvben: most már használja műszaki dokumentáció (technikai dokumentáció a rövidítés) bármilyen dokumentumra utal, amely technikai információkat tartalmaz — használata helyett. jelentés. A jelentés egy alcsoport a könyvben tárgyalt egyéb műszaki dokumentumok mellett.
Megjegyzés: Ez a műszaki írás tankönyv a műszaki írási készségek. A technikai tartalom itt nem garantáltan pontos vagy naprakész.
Bevezetés: Műszaki írás
A műszaki írás alkalmazásai
Megjegyzés: Ez az online tankönyv most használja műszaki dokumentum, vagy csak technikai dokumentáció, olyan esetekben, amikor jelentés túl specifikus. (ENS emblémák) jelzik, hogy a fordítások elérhetők, ha rákattint a linkre.
- Üzleti és foglalkoztatási dokumentumok:
- Technikai dokumentációk felmérése
- Adatjelentések
- Üzleti tervek
- Javaslatok
- Haladási jelentések
- Utasítások
- Műszaki jelentések (techdocs)
- Irodalmi áttekintések
- Mérnöki tervezési jelentés
- Fehér könyvek
- Technológia-orientált használati útmutatók
- Útmutatók és irányelvek dokumentumai
- Szabványos működési politikák és eljárások
- Ajánlási és megvalósíthatósági jelentések
- Kézikönyvek
- Előszó és utószó:
- Szóbeli előadások
Információs struktúrák
Az információs struktúrák hosszabb dokumentumok részeként használhatóak, de önálló dokumentumokként is alkalmazhatóak, különösen technikai írási projektek esetén. Ezek az információs struktúrák jó kiindulópontot jelentenek a fejlődő technikai írók számára.
Dokumentumtervezés
- Techdoc tervezési áttekintés
- Könyvterv áttekintés
- Oldalterv áttekintés
- Címek
- Listák
- Különleges értesítések
- Nem szövegesek: táblázatok, ábrák, diagramok
- Techdoc formátum és végső csomagolás
- Kiemelés és hangsúlyozás
- Indexelés
Folyamatok és Irányelvek a Műszaki Írásban
- Írási folyamat: a közönségtől a vázlatig
- Közönség elemzés
- Feladat elemzés
- Technikai információk fordítása
- Hatékony revíziós technikák
- Könyvtárak, dokumentáció, kereszt-referenciák
- Információgyűjtés (TésztaEszközök vagy Notebook LM)
- Idézetek, Parafrázisok, Összefoglalók: Megfogalmazás, Írásjelek, Hivatkozás
- A mondat alapvető mintái és elemei
- Általános nyelvtani, használati, írásjelezési problémák
- Gyakori helyesírási problémák
- Stratégiák a társak átnézésére és a csapatírásra
- Hivatkozási munkák linkjei
Példák, Esetek és Modellek: Index
- Önéletrajzok
- Jelentkezési levelek
- Panaszlevelek
- Helyesbítő levelek
- Érdeklődő levelek
- Rendezd a betűket
- Javaslatok
- Haladási jelentések
- Utasítások
- Felhasználói kézikönyvek
- Ajánlási jelentések
- Adat-elemzési jelentések
- Műszaki jelentések (techdok)
- Elsődleges kutatási jelentések
- Műszaki adatok
- Szóbeli beszámolók
- Jelentések és szakaszok bevezetése
- Leírások
- Összehasonlítások
- Klasszifikáció (Kategorizálás)
- Okozati elmondás
- Meghatározások
- Folyamat-elbeszélés
- Meggyőzés
