Példákat keres a műszaki írásra diákok számára? Akár tanár, aki mintákat keres, amelyeket megoszthat a tanulóival, vagy diák, aki olyan meglévő dokumentumokat keres, amelyek útmutatást nyújthatnak az órai feladaton, a technikai írási példák áttekintése nagyon hasznos lehet.
Mi az a műszaki írás?
A technikai írás egy nagyon speciális írástípus. Azt a célt szolgálja, hogy meghatározott információkat közöljön egy meghatározott célközönséggel. A technikai írás oktató jellegű, és olyan módon igyekszik információt közvetíteni az olvasó számára, hogy az megértse és alkalmazható legyen. Az ilyen típusú írásoknál a világosság és a konkrétság elengedhetetlen, csakúgy, mint a célközönség tagjai számára könnyen érthető terminológiával történő kommunikáció.
A következő három példa szemlélteti a technikai írást.
Szabványos működési eljárások (SOP)
Egy SOP egyértelműen meghatározza a szervezetek folyamatait:
Miután egy munkatárs visszatér a távollétéből, a munkavállalónak ki kell töltenie az S meghajtón található minősített alkalmazotti távolléti jelentést:
- Kattintson a "Sajátgép" elemre
- Kattintson duplán az "S Drive" nevű hálózatra
Jogi felelősség kizárása
A jogi felelősség kizárása az olvasott tartalomhoz kapcsolódó jogi keretről tájékoztat:
Ezt a kommunikációt az Electronic Privacy Act (24 USCA 2674) védi. A 24 USCA 2675. értelmében szigorúan tilos az ebben az átvitelben szereplő információk bármilyen jogellenes lehallgatása vagy közzététele.
Súgófájlok
A súgófájlok alapvető olvasási szinten, szakzsargon nélkül íródnak, és csak néhány lépésnyi utasítást tartalmaznak. A cél az, hogy segítsünk az alkalmazottaknak vagy ügyfeleknek megoldani a problémákat önállóan:
Súgótéma: Testreszabás
Az irányítópulton kiválaszthatja a kezdőképernyőn megjelenő képet. A számítógéphez tíz kép tartozik, vagy feltöltheti sajátját. Ehhez hajtsa végre a következő lépéseket
Hol találhat példákat a diákok számára online technikai írásra
Számos online forrás található a diákoknak szánt műszaki írás példáihoz. Néhány hely, ahol érdemes lehet ilyen típusú írásmintákat találni:
- Eduscapes- Az Eduscapes webhely olyan tanárok és könyvtárosok számára készült, akik olyan anyagokat keresnek, amelyekkel órákat hozhatnak létre vagy javíthatnak. Sok más oktatóanyag mellett ezen az oldalon számos technikai írási példa, valamint tippek találhatók az ilyen típusú készségek hatékony oktatásához.
- HelpScribe.com - A HelpScribe.com webhelyen számos technikai írási példa található, amelyeket áttekinthet. Vannak minták a műszaki kézikönyvekből, a rendszerkövetelmények dokumentációjából, a súgódokumentumokból, az utasításokból és más típusú dokumentumokból.
- Technikai írásszolgáltatók – A műszaki írási szolgáltatásokat nyújtó cégek és magánszemélyek gyakran tesznek közzé példákat munkájukról weboldalaikon marketingforrásként. Néhány webhely, amelyeket érdemes átnéznie, amikor mintadokumentumot keres: JPC Media, LLC; Paul MacMartin, műszaki író; és a Warthman Associates.
További források műszaki írásmintákhoz
Noha az internet remek hely a műszaki írások példáinak megkeresésére, természetesen nem ez az egyetlen hely, ahol megtalálhatja az igényeinek megfelelő dokumentumokat. Jó esély van arra, hogy otthonában vagy irodájában számos példa található műszaki írásra. Ha rendelkezik használati útmutatóval bármely elektronikus eszközhöz vagy készülékhez, akkor van egy példa a műszaki dokumentációra.
A használati útmutatókon kívül más kiadványok is elérhetők otthon vagy munkahelyen:
- Alkalmazotti kézikönyv – A vállalatok egy kézikönyvet biztosítanak alkalmazottaiknak, amely részletezi a szervezet irányelveit és eljárásait. Ha jelenleg nem dolgozik, kérje meg állásban lévő barátait vagy rokonait, hogy mutassák meg a cégük kézikönyveinek másolatát.
- Használati útmutatók – Az irodájában lévő másoló- vagy faxkészülékhez valószínűleg használati utasítás is tartozott.
- Szoftverdokumentáció – Minden alkalommal, amikor szoftveralkalmazási licencet vásárol, a program telepítésével és használatának megkezdésével kapcsolatos dokumentációt mellékeljük.
- Tanulói kézikönyv – Ha Ön diák, az iskolája valószínűleg kapott egy kézikönyvet, amely különféle irányelveket és eljárásokat ismertet.
Legyen diszkréció a példák kiválasztásakor
Ne feledje, hogy minden technikai írásminta, amellyel találkozik, nem feltétlenül jó példa. Egyes esetekben előfordulhat, hogy olyan dokumentumokat találhat, amelyek jobban illusztrálják, hogy mit ne tegyünk, semmint iránymutatásként arra vonatkozóan, hogy mit kell tennie Önnek vagy diákjainak. Ha valaha is vásárolt olyan elemet, amelyet csak azért kellett összeszerelni, mert úgy találta, hogy az utasítások nem elégségesek vagy nehezen követhetőek, akkor első kézből tapaszt alta, hogy a technikai írás nem megfelelő. Tekintse át a felhasználni kívánt példadokumentumokat, hogy megbizonyosodjon arról, hogy az információ minősége és az írásmód megfelel a tervezett célnak.
