Ez az online műszaki szövegírással foglalkozó könyv mostantól használ műszaki dokumentum (műszaki dokumentáció jelentés. A jelentés az ebben a könyvben tárgyalt egyéb műszaki dokumentumok egyik alkategóriája.
Megjegyzés: Ez a műszaki írással foglalkozó tankönyv összpontosít műszaki szövegírási készségek. A műszaki tartalom itt nem garantáltan pontos vagy naprakész.
Háttér/információs jelentések
Ez a típus a legnehezebben meghatározható, de az, amelyet a legtöbben írnak. Egy műszaki témára összpontosít, háttérinformációt nyújt arról a témáról egy meghatározott olvasói kör számára, akiknek konkrét igényeik vannak vele kapcsolatban. Ez a jelentés nem ad utasításokat, nem ad ajánlásokat rendszerszerű módon, és nem közöl új, eredeti adatokat.
A teljes fejezetért erről a típusú technikai dokumentációról, lásd háttér/információs jelentések
Üzleti tervek
Az üzleti terv egy dokumentum, amelyet új vállalkozás indításához vagy egy jelentős változáson áteső vállalkozás finanszírozásának megszerzéséhez használnak. Az üzleti tervek fontos dokumentumok az üzlettársak számára, akiknek egyet kell érteniük a terveket illetően, a hatóságok számára, amelyeknek jóvá kell hagyniuk a tervet, és természetesen a potenciális befektetők számára, például bankok vagy magánszemélyek, akik finanszírozhatják a vállalkozást.
Lásd a Kérlek, illeszd be a lefordítandó angol szöveget (a teljes fejezetet). ezen az ilyen típusú műszaki dokumentumon.
Technológia-orientált felhasználói útmutatók
Röviden meghatározva, egy számítógép-használati útmutató technikai információkat nyújt arról, hogyan kell számítógépes hardvert vagy szoftvert használni, beleértve az olyan feladatokra vonatkozó utasításokat, mint a telepítés, a konfiguráció és az alapvető feladatok.
Lásd a teljes fejezet ezen a típusú műszaki dokumentáción.
Adatjelentések
Egy adatjelentés olyan műszaki dokumentum, amely sok adatot tartalmaz táblázatok formájában. Továbbá tartalmazhat diagramokat és grafikonokat, amelyek szemléletesebben ábrázolják a táblázatok adatait, valamint magyarázó kereszthivatkozásokat, amelyek megfogalmazzák a táblázatos adatok főbb trendjeit és következtetéseit.
Lásd a teljes fejezet ilyen típusú technikai dokumentáción.
Mérnöki tervezési jelentések
Egy mérnöki tervezési jelentés bemutatja és dokumentálja a mérnöki tervezési projektet, hogy mások megértsék, hogyan alkalmazható és kereskedelmi forgalomba hozható a terv. Például mérnökhallgatók írtak a mikrovezérlőt használó hőmérsékletmérő és kijelző rendszer tervezéséről.
Lásd a teljes fejezet erről az ilyen típusú technikai dokumentációról.
Útmutatók és iránymutató dokumentumok
Röviden meghatározva, egy útmutató Ez a kiadvány lépésről lépésre szóló útmutatásokat, tippeket és kapcsolódó fogalmakat tartalmaz. Tartalmazhat továbbá hibaelhárítási információkat, linkeket kapcsolódó közösségekhez, és linkeket kapcsolódó kutatásokhoz.
Egy útmutató dokumentum egy kormányzati dokumentum, amelynek célja, hogy hasznos információkat nyújtson a nyilvánosságnak, például azzal, hogy tisztázza a meglévő törvény vagy rendelet szerinti kötelezettségeket. Arra törekszik, hogy lefordítsa az adminisztratív szabályok összetett jogi nyelvezetét, hogy a nyilvánosság be tudja tartani ezeket a szabályokat.
Lásd a teljes fejezet az ilyen típusú műszaki dokumentációkról.
Kézikönyvek
Röviden meghatározva, a kézikönyv egy sokoldalú forrás, amely elméleti információkat (alapvető elméletek, elvek, alapok), útmutató jellegű információkat (lépésről lépésre szóló utasítások), és hivatkozási információkat (gyorsan lekérdezhető információk) tartalmaz.
Lásd a teljes fejezet ilyen típusú műszaki dokumentumon.
Utasítások
Röviden meghatározva, az utasítások megmondják, hogyan kell dolgokat építeni, üzemeltetni, javítani—a klasszikus "hogyan kell." Műszaki szövegírást tanuló diákok számára inkább "Technológia-orientált felhasználói útmutatók."
Lásd a teljes fejezet ezen a típusú technikai dokumentumon.
Irodalmi áttekintések
Röviden megfogalmazva, egy irodalmi áttekintés összefoglalja, mit tudunk egy adott kutatási témáról, bemutatja a kutatás történetének mérföldköveit, jelzi, hol vannak ellentmondások a jelenlegi ismeretekben, és megvitatja azokat a területeket, ahol az ismeretek még hiányosak.
Lásd a teljes fejezet ezen típusú technikai dokumentáción.
Elsődleges kutatási jelentések (laboratóriumi jegyzőkönyvek)
Röviden megfogalmazva, egy elsődleges kutatási jelentés bemutatja a laboratóriumi vagy terepi kutatás eredményeit és azok értelmezését. Úgy is tekinthet rá, mint egy laboratóriumi jelentésre, de ennél sokkal több.
Lásd a Kérlek, illeszd be a fordítandó angol fejezetet. erről az ilyen típusú technikai dokumentumról.
Előrehaladási jelentések
Röviden megfogalmazva, egy haladási jelentés tájékoztat egy felügyelőt, munkatársat vagy ügyfelet egy projekt előrehaladásáról egy adott időszak alatt. A projekt lehet valaminek a tervezése, kivitelezése vagy javítása, egy probléma vagy kérdés tanulmányozása vagy kutatása, vagy műszaki témában végzett információgyűjtés.
Lásd a teljes fejezet ilyen típusú műszaki dokumentáción.
Javaslatok
Röviden meghatározva, a javaslat egy ajánlat vagy pályázat arra, hogy valaki számára megvalósítsanak egy bizonyos projektet. Amitől egy javaslat javaslattá válik, az az, hogy azt kéri a címzettektől, hogy hagyják jóvá, finanszírozzák, vagy engedélyezzék a javasolt projekt megvalósítását.
Lásd a Kérlek, illeszd be a lefordítandó angol szöveget (a teljes fejezetet), hogy lefordíthassam magyarra. ilyen típusú műszaki dokumentáción.
Ajánlási, megvalósíthatósági, értékelési jelentések
Lásd a teljes fejezet az ilyen típusú technikai dokumentációkról.
Szabványos működési irányelvek és eljárások
Ezek a szervezetek működési dokumentumai; szabályokat és előírásokat tartalmaznak arra vonatkozóan, hogy a szervezetnek és annak tagjainak hogyan kell működniük. Az irányelvek és eljárások olyanok, mint az utasítások, de jóval többet nyújtanak. A standard működési eljárások (SOP-ok) inkább azokra az eljárásokra vonatkoznak, amelyeknél egy folyamatot hajtanak végre—például egy foglenyomat készítése.
Lásd a teljes fejezet az ilyen típusú technikai dokumentumokról.
Műszaki könyvkiadás
Hamarosan...
Lásd a teljes fejezet egy ilyen típusú műszaki dokumentációról.
Technológia-orientált felhasználói útmutatók
Röviden megfogalmazva, egy számítógépes felhasználói útmutató műszaki információkat nyújt arról, hogyan kell használni a számítógép hardverét vagy szoftverét, beleértve az olyan feladatokra vonatkozó útmutatásokat, mint a telepítés, a konfiguráció és az alapvető feladatok.
Lásd a teljes fejezet erről az ilyen típusú műszaki dokumentációról.
Fehér könyvek
Röviden meghatározva, a fehér könyv egy technológiai vagy üzleti dokumentum, amely egy projekt (eszköz, módszer stb.) hátterét ismerteti és mellette érvel. A fehér könyvek népszerű marketingeszközzé váltak a vállalatok számára, különösen az Interneten, mivel sok potenciális vásárló a Weben keres információt. A vállalatok fehér könyveket használnak információ vagy új termékek eladására olyan megoldásként, amelyek kielégítik ügyfeleik igényeit.
Lásd a teljes fejezet erről az ilyen típusú műszaki dokumentációról.
Kapcsolódó információk
Dokumentumok típusai és használatuk. Mi a fene?
