A műszaki szakembereknek gyakran kell definiálniuk vagy leírniuk egy műszaki tárgyat, fogalmat vagy folyamatot egy olyan személy számára, akinek kevés ismerete vagy tapasztalata van ezzel kapcsolatban. Például egy mérnöki cég írhat egy ajánlatot egy helikopter kifejlesztésére irányuló szerződésre a Védelmi Minisztérium számára; az ajánlat egyik része a cég által kifejlesztésre javasolt termék részletes leírása lenne. A műszaki leírásokat a termékek és folyamatok kifejlesztése előtt (az ajánlatok és tervezési dokumentumok részeként), a fejlesztés során (például az előrehaladási jelentésekben) és utána (a marketing- és promóciós irodalom és a műszaki támogató dokumentumok részeként) használják.
Témaválasztás
Ez a feladat arra kéri, hogy válasszon ki egy terméket vagy folyamatot, és írjon róla leírást.A műszaki leírásoknak két különböző fajtája létezik. Válassza ki a témájától függően a megfelelőt.
Megjegyzés: Érdemes olyasmit választani, amit már ismer, így a leírás megírásának megtanulására összpontosíthat, nem pedig arra, hogy egyszerre tanulja meg a leírás megírását és a termék vagy folyamat megismerését!
A termékleírás egy adott eszköz, például egy tudományos műszer vagy számítógépes program jellemzőit magyarázza el. A lehetséges témák közé tartoznak a szakterületedre jellemző eszközök, vagy a mindennapi életben használt eszközök:
- – Kézi fűnyírógép
- – Üzemanyagcella
- – Akkumulátor
- – Katalizátor
- – Kézi konzervnyitó
- – A kedvenc számítógéped vagy videojátékod
- – Egy adott autómodell
A folyamatleírás elmagyarázza, hogyan történik egy komplex esemény, beleértve egy mechanikai folyamatot (pl. i.pl. hogyan készülnek a fánkok) vagy természeti esemény (pl. hogyan keletkezik a villám). Választhat olyan folyamatot, amely a szakterületére jellemző, vagy olyan folyamatot, amelyre az emberek kíváncsiak lehetnek:
- – Hogyan működik egy adott gyógyszer
- – Hogyan készül az acél
- – Hogyan működnek az üzemanyagcellák
- – Hogyan fordít le és hajt végre egy számítógép egy programot
- – Hogyan működik a mikrohullámú sütőd
- – Hogyan sugározzák be az élelmiszereket
Megjegyzés: A termék vagy folyamat leírása nem utasításkészlet. Az utasításkészlet olyan lépéseket ad meg, amelyeket a felhasználó egy feladat elvégzése érdekében tesz meg (például az autó olajcseréjének lépései). Ezzel szemben a termék- és folyamatleírások leírják, hogyan működik valami (például hogyan működik az olaj a motor hűtésére). A kontraszt aközött van, hogy hogyan kell használni valamit és hogyan működik az a dolog (pl. hogyan kell használni egy mikrohullámú sütőt, szemben azzal, hogy a mikrohullámú sütő hogyan melegíti fel az ételt). Ennél a feladatnál arra kell összpontosítania, hogyan működnek a dolgok, nem pedig arra, hogyan kell használni őket. A következő feladatban az utasításokra kell majd összpontosítania.
Specifikus követelmények
A közönség és a cél
Válasszon ki egy olyan közönséget, amely érdeklődik az ön által ismertetett folyamat vagy termék megismerése iránt. Például feltételezheti, hogy a közönség elsőéves főiskolai hallgatókból áll, akik egy tankönyvben olvasnak a témáról. Írhatnál egy marketing dokumentumot, hogy meggyőzd az embereket egy termék megvásárlására. Vagy írhatnál egy olyan leírást, amely egy potenciális ügyfélnek küldött ajánlat részét képezné. A feladatban azt kell feltételezned, hogy a leírás kulcsfontosságú a közönséged munkája szempontjából, azonban az olvasóid nem szakértői a témának. Ön a szakértő, aki elmagyarázza a terméket vagy folyamatot az olvasónak.
Információgyűjtés
Foglaljon időt arra, hogy mindent megtudjon az Ön által kiválasztott termékről vagy folyamatról, még akkor is, ha már ismeri azt. Olvasson háttérinformációkat, vagy más módon tájékozódjon a témáról. Sorolja fel a forrásokat az Idézett művek vagy a Felhasznált művek részben.
Tartalom/szervezés
A leírások megírásához Markel négy alapelvét fogjuk követni:
- Világosan jelezze a leírás jellegét és terjedelmét. Ez a rész tartalmazni fog információkat a célközönségről, a célközönség tudásszintjéről és arról is, hogy miért lehet szüksége a célközönségnek erre a leírásra.
- Tartalmazza a termék/folyamat bemutatását. A legtöbb bevezető általános – adjon az olvasónak egy átfogó áttekintést a témájáról. Tartalmazzon egy mondatos (vagy hosszabb) definíciót. Sok bevezető tartalmaz egy képanyagot is.
- Adjon megfelelő részletességet. Ez lesz a leírásod “teste”. Termékek esetében részletesen írja le az egyes részeket, beleértve a méreteket, az anyagokat, a funkciókat és a többi részhez való viszonyukat. Folyamatok esetében részletesen írja le az egyes lépéseket. Mindkét esetben ne feledje, hogy minden nyelvi/diskurzusbeli választást a hallgatóság érdeklődési szintje, tapasztalata és a témával kapcsolatos ismeretei alapján hozzon meg.
- Írjon konklúziót. A következtetés összefoglalja a leírást. Gyakran a konklúzió leírja, hogy az előzőleg leírt részek hogyan működnek együtt. Arra is emlékeztetheti a hallgatóságát, hogy ez a termék vagy folyamat végső soron hogyan segít a hallgatóságnak megoldani egy problémát (vagy gazdagítja az életét!).
Formátum
Foglaljon bele olyan tervezési jellemzőket, amelyek segítik az olvasót az információk megtalálásában és a termék vagy folyamat jobb megértésében: diagramok, címsorok, felsorolásos/számozott listák és más technikai kommunikációs konvenciók, amelyeket megismert. Tartalmazzon egy fedőlapot, amely azonosítja a címet, a szerzőt, a célközönséget és a dátumot. A végleges dolgozatnak legalább 1000 szót kell tartalmaznia, és egy sorközzel kell írnia.
Vizuális eszközök
Itt két lehetősége van. Először is, kidolgozhatod a saját vizuális anyagodat (egy kézi vázlat is megfelel, ha nem tudod, hogyan kell számítógépes programmal elkészíteni). Vagy használhatsz egy “referencia látványtervet”, ami egy közzétett kép másolata. Ha közzétett képet használ, feltétlenül hivatkozzon a forrásra, és beszéljen arról, hogy a képnek milyen módosításokra van szüksége ahhoz, hogy az Ön kontextusába illeszkedjen. (Ha például egy hómaró motorjának működését írja le, akkor a gyártó weboldaláról származó képet használhatja, ahelyett, hogy sajátot rajzolna.)
Értékelési kritériumok
Az útmutatókat az alábbi elvárások szerint fogom értékelni:
| Teljesség
Részletesség |
A leírás teljes (tartalmazza az összes kért információt).Emellett a leírás követi Markel leírások írására vonatkozó négy alapelvét.A leírás világos és tartalmas. A leírás átfogó, konkrét és pontos részleteket tartalmaz. A mondatmeghatározás hatékonyan kezdi a leírást, és a látvány fokozza a leírást. |
| Formátum/szervezés | Az olvasók megtalálják a szükséges információkat. A tervezési jellemzők javítják az olvashatóságot. A bekezdések hatékony témamondatokat használnak. |
| Stílus | A leírás hatékony mondatokban ad konkrét információkat. |
| A közönséghez való alkalmazkodás | A leírás egyértelműen egy meghatározott közönséghez szól, és segít a közönségnek megérteni a terméket vagy folyamatot. |
| Mechanika | A helyesírás, a nyelvtan és az írásjelek helyesek. |
Nézze meg a tanulói mintákat.