Jegyzetek:
• A tankönyv fejezeteit az OpenAI segítségével fordították, és hibákat tartalmazhatnak. Ha problémákat talál a fordításokban, kérjük, küldjön javításokat a szerzőnek a admin@mcmassociates.io címre.
• Ha itt elavult vagy pontatlan technológiát találsz, kérlek, küldj javításokat. Ne feledd azonban, hogy ez egy könyv a műszaki írásról, nem pedig egy technológiai kézikönyv—a régebbi technológiák még mindig hasznos példákat nyújthatnak.
• Adományozz, hogy megőrizzük Online Műszaki Írás Tankönyv ingyenes.
• Amíg itt vagy, küldj egy barátságos üdvözlő e-mailt Davidnak: admin@mcmassociates.io
Nagy változás történt e tekintetbeni online műszaki írás könyvben: mostantól használja műszaki dokumentum (technikai dokumentáció röviden) bármely olyan 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.
Bevezetés: Műszaki Írás
- Mi újság?
- A műszaki írásról
- Műszaki írási tanfolyamokról
- Erőforrások
- A szerzőről
- Köszönetnyilvánítás
- Hivatkozások a referencia művekre
A műszaki írás alkalmazásai
Megjegyzés: Ez az online tankönyv most már használja műszaki dokumentum, vagy csak technikai dokumentáció, olyan esetekben, amikor jelentés túl specifikus. (ENS emlékek) jelzik, hogy a fordítások elérhetők, ha rákattint a linkre.
- Technikai dokumentációk felmérése
- Üzleti és munkával kapcsolatos dokumentumok:
- Adatjelentések
- Üzleti tervek
- Javaslatok
- Ajánlások és megvalósíthatósági jelentések
- Fehér könyvek
- Haladási jelentések
- Utasítások
- Háttérjelentések
- Mérnöki tervezési jelentés
- Technológiára orientált felhasználói útmutatók
- Műszaki specifikációk és adatlapok
- Kiadási megjegyzések
- Használati esetek, esettanulmányok
- Standard működési politikák és eljárások
- Elsődleges kutatási jelentések. Laborra és terepre.
- Irodalmi áttekintések
- Útmutatók és irányelvek
- Kézikönyvek
- Elő- és utószó:
Információs struktúrák
Az információs struktúrák hosszabb dokumentumok részeként használhatók, de önálló dokumentumokként is alkalmazhatók, különösen műszaki írási projektek esetén. Ezek az információs struktúrák jó kiindulópontot jelentenek a fejlődő műszaki írók számára.
Dokumentumtervezés
- Techdoc tervezési áttekintés
- Könyvterv áttekintés
- Oldalterv áttekintése
- Címek
- Listák
- Különleges értesítések
- Nem szöveges elemek: táblázatok, ábrák, diagramok
- Techdoc formátum és végső csomagolás
- Kiemelés és hangsúlyozás
- Indexelés
Folyamatok és Útmutatók 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
- Teljesítmény-áttekintési technikák
- Információfeldolgozás
- Információgyűjtés (NoodleTools vagy Notebook LM)
- Idézetek, парафразák, összefoglalók: Fogalmazás, írásjelek, hivatkozás
- A mondat alapvető mintái és elemei
- Gyakori nyelvtani, használati, írásjelezési problémák
- Gyakori helyesírási problémák
- Stratégiák a társnéző és csapatírás folyamatához
