Ez az online műszaki szövegírási könyv mostantól használ műszaki dokumentum (technikai dokumentum röviden) bármely olyan dokumentumra utalni, amely műszaki információkat tartalmaz—a használat helyett jelentésA jelentés a könyvben tárgyalt egyéb műszaki dokumentumok egyik alkategóriája.
Megjegyzés: Ez a műszaki írásról szóló tankönyv a következőkre összpontosít műszaki szövegírási készségekA műszaki tartalom itt nem garantáltan pontos vagy naprakész.
Háttér- és tájékoztató jelentések
Ez a típus a legnehezebben meghatározható, de ugyanakkor azt, amit a legtöbben írnak. Egy műszaki témára összpontosít, és háttérinformációt nyújt az adott 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 nyújt ajánlásokat rendszerszerű módon, és nem közöl új, eredeti adatokat.
Ezen típusú technikai dokumentáció teljes fejezetéhez lásd: háttér- és információs jelentések
Üzleti tervek
Az üzleti terv olyan dokumentum, amelyet új vállalkozás indításához vagy egy olyan, jelentősen változó vállalkozás finanszírozásának megszerzéséhez használnak. Az üzleti tervek fontos dokumentumok az üzlettársak számára, akiknek meg kell egyezniük a terveikről, a kormányzati tisztviselők számára, akiknek jóvá kell hagyniuk azt a tervet, és természetesen a lehetséges befektetők — például bankok vagy magánszemélyek — számára, akik finanszírozhatják a vállalkozást.
Lásd a teljes fejezet ezen a típusú műszaki dokumentáción.
Számítógép-használói útmutatók
Röviden megfogalmazva, egy számítógép-használói útmutató műszaki információkat ad 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 erről az ilyen típusú műszaki dokumentációról.
Adatjelentések
Az adatjelentés egy technikai dokumentum, amely sok adatot tartalmaz táblázatok formájában. Tartalmazhat továbbá diagramokat és grafikonokat, amelyek szemléletesebben ábrázolják a táblázatokban szereplő adatokat, valamint magyarázó keresztreferenciákat, amelyek megfogalmazzák a táblázatos adatok fő tendenciáit és következtetéseit.
Nézd meg a teljes fejezet erről az ilyen típusú műszaki dokumentumról.
Tervezési jelentések
A mérnöki tervezési jelentés bemutatja és dokumentálja a mérnöki tervezési projektet, hogy mások megértsék, miként alkalmazható és hogyan lehet kereskedelmi forgalomba hozni a megoldást. Például mérnökhallgatók írtak a mikrovezérlővel megvalósított hőmérsékletmérés és -kijelzés rendszerének tervezéséről.
Lásd a teljes fejezet Erről az ilyen típusú műszaki dokumentációról.
Útmutatók és iránymutató dokumentumok
Röviden meghatározva, egy útmutató Egy kiadvány, amely lépésről lépésre útmutatásokat, tippeket és kapcsolódó fogalmakat nyújt. Tartalmazhat továbbá hibaelhárítási információkat, a kapcsolódó közösségekhez vezető hivatkozásokat és a kapcsolódó kutatásokra mutató hivatkozásokat.
Egy útmutató dokumentum Ez egy kormányzati dokumentum, amelynek célja, hogy hasznos információkat nyújtson a nyilvánosságnak, például egy meglévő törvény vagy rendelet szerinti kötelezettségek tisztázásával. Arra törekszik, hogy lefordítsa az igazgatási szabályok bonyolult jogi nyelvezetét, hogy a nyilvánosság be tudja tartani ezeket a szabályokat.
Lásd a teljes fejezet az ilyen típusú technikai dokumentumokról.
Kézikönyvek
Röviden definiálva, egy kézikönyv egy Online műszaki írás tan forrás, amely koncepcionális információkat (alapvető elméletek, elvek, alapok), oktató jellegű információkat (lépésről lépésre szóló utasítások) és hivatkozási információkat (gyorsan előkereshető információk) tartalmaz.
Lásd a teljes fejezet erről az ilyen típusú műszaki dokumentációról.
Utasítások
Röviden meghatározva, az utasítások elmondják, hogyan kell dolgokat építeni, hogyan kell dolgokat üzemeltetni, hogyan kell dolgokat megjavítani—a klasszikus "hogyan kell".
Lásd a teljes fejezet ilyen típusú műszaki dokumentációról.
Szakirodalmi áttekintések
Röviden megfogalmazva a szakirodalmi áttekintés összefoglalja, mit tudunk egy adott kutatási témáról, ismerteti a kutatás történetének mérföldköveit, rámutat arra, hol vannak ellentmondások a jelenlegi tudásban, és tárgyalja azokat a területeket, ahol még ismeretlenek maradnak.
Lásd a teljes fejezet ilyen típusú technikai dokumentáción.
Elsődleges kutatási jelentések (laboratóriumi jelentések)
Röviden: egy elsődleges kutatási jelentés bemutatja a laboratóriumi vagy terepi kutatás eredményeit és azok értelmezését. Gondolhat rá úgy, mint egy laborjelentésre, de sokkal több annál.
Lásd a teljes fejezet ilyen típusú műszaki dokumentáción.
Előrehaladási jelentések
Röviden meghatározva, egy előrehaladási jelentés tájékoztatja a felettest, munkatársat vagy ügyfelet egy projekt egy meghatározott időszakon belüli előrehaladásáról. 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, illetve információgyűjtés egy műszaki témában.
Lásd a teljes fejezet Erről az ilyen típusú műszaki dokumentációról.
Javaslatok
Röviden meghatározva: a javaslat egy ajánlat vagy pályázat arra, hogy valaki számára elvégezzenek egy bizonyos projektet. Amitől egy javaslat javaslattá válik, az az, hogy azt kéri a címzettektől, hogy fogadják el, finanszírozzák vagy adjanak engedélyt a javasolt projekt megvalósítására.
Lásd a teljes fejezet erről a típusú műszaki dokumentációról.
Ajánlási, megvalósíthatósági és értékelési jelentések
Ez a hasonló jelentésekből álló csoport olyan feladatokat végez, mint például több lehetőség összehasonlítása egy követelményrendszerrel és egy lehetőség ajánlása; egy ötletet (tervet, projektet) megvizsgál a "megvalósíthatósága, " például műszaki, gazdasági vagy társadalmi gyakorlatiasságának vagy lehetségességének valamilyen kombinációja alapján; illetve ítéletet hoz egy dolog értékéről azáltal, hogy összehasonlítja azt egy követelményhalmazzal (kritériumokkal).
Lásd a teljes fejezet az ilyen típusú műszaki dokumentációkról.
Szabványos működési irányelvek és eljárások
Ezek a szervezetek működési dokumentumai; tartalmazzák azokat a szabályokat és előírásokat, amelyek meghatározzák, hogyan kell a szervezetnek és tagjainak működniük. A politikák és eljárások olyanok, mint az utasítások, de sokkal tovább mennek. A szabványos működési eljárások (SOP-k) inkább olyan eljárásokhoz tartoznak, amelyek során egy folyamatot hajtanak végre—például foglenyomat készítése.
Lásd a teljes fejezet az ilyen típusú technikai dokumentációkról.
Fehér könyvek
Röviden meghatározva, a fehér könyv egy technológiai vagy üzleti dokumentum, amely háttérinformációkat nyújt egy projektről (eszköz, módszer stb.) és érvel mellette. A fehér könyvek népszerű marketingeszközökké váltak a vállalatok számára, különösen az interneten, mivel sok potenciális ügyfél az interneten keres információt. A vállalatok fehér könyveket használnak arra, hogy információt vagy új termékeket értékesítsenek 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
A dokumentumok típusai és használatuk. Mit tegyek
