Technical Writing Essentials

A leíró műszaki írás a vizuális és szöveges elemek kombinációját használja, hogy “megmutassa” és “elmondja” az olvasónak a közvetített információt. A kreatívabb leírásokhoz hasonlóan a műszaki leírások néha az “öt érzékszervre” és metaforikus összehasonlításokra (analógiákra) támaszkodnak, hogy az olvasó teljes mértékben fel tudja fogni a leírtakat. Gyakrabban azonban konkrét, mérhető leírásokra támaszkodnak. A műszaki leírások a céltól és a célközönségtől függően sokféle formát ölthetnek. A leírások terjedhetnek egy rövid mondattól kezdve egy bekezdésig, egy jelentés egész szakaszáig vagy egy egész kézikönyvig. A rosszul megírt műszaki leírások zavart okozhatnak, időt pazarolhatnak, és akár katasztrófához is vezethetnek! A műszaki termékleírásokat gyakran jogszabály írja elő a biztonság és a megfelelőség biztosítása érdekében. A részletekre való odafigyelés kritikus fontosságú.

A termékleírások megkövetelik a tervezési jellemzők részletes leírását; az utasítások gyakran különleges leíró részleteket igényelnek, hogy “megmutassák” az olvasónak, mit kell tennie. A műszaki leírások néhány általános kategóriája a következő:

• Mechanizmusleírások: részletes áttekintést nyújtanak egy szerszám, gép vagy más mechanikus eszköz fizikai aspektusairól, amely mozgó alkatrészekkel rendelkezik, és amelyet egy adott funkció elvégzésére terveztek. Ezek lehetnek értékesítési vagy gyártási célú termékleírások, tervezési specifikációk dokumentációja, infografikák stb. Ez a fejezet részletesen foglalkozik ezzel a fajta leírással.
• Folyamatleírások: olyan események (természeti/biológiai/ökológiai, mechanikai, társadalmi vagy pszichológiai jelenségek) sorozatát részletezik, amelyek meghatározott sorrendben történnek egy adott eredmény elérése érdekében. Ezek kategorizálhatók nem oktatási folyamatokra (például egy belsőégésű motor működésének folyamatelemzése, vagy olyan természeti folyamatok, mint a fotoszintézis) és oktatási folyamatokra (például ajánlott/követelményes eljárások és explicit, lépésről lépésre követendő utasítások). (Az utasítások írásával kapcsolatos részletes információkért lásd a 7.7. szakaszt.)
• Definíciók: tisztázzák a konkrét jelentést, gyakran egy adott kontextushoz kapcsolódva, vagy kifejezik a definiált kifejezések lényegi természetét. Ezek hossza egy egyszerű tisztázó mondattól egy több oldalas, terjedelmes dokumentumig terjedhet. A definíciók gyakran tartalmaznak részletes leírásokat és képi ábrákat a gondolatok illusztrálására. Az alábbi linkre kattintva megtekinthet egy diák PowerPoint prezentációt arról, hogyan kell hatékony definíciókat írni műszaki célokra. Ez a prezentáció a tanuló kifejezett engedélyével szerepel.

Definíciók a műszaki szövegalkotásban – Tanulói prezentációminta (.pdf)

A mechanika leírásának világos képet kell nyújtania a leírt tárgyról, beleértve

• Általános megjelenés és fizikai tulajdonságok
• Általános funkció/cél
• A komponensek részei
• Hogy a részek kölcsönhatása hogyan alkot egy működő egészet.

Az olvasónak világosan el kell tudnia képzelni, és ezáltal meg kell értenie a leírt tárgy természetét, azt, hogy mit csinál, és hogyan működik.

Az írónak ahhoz, hogy az olvasó számára ezt a világosságot elérje, jelentős részleteket kell kiválasztania, és az információkat logikusan kell rendszereznie. Válasszon olyan részleteket, amelyek pontosan és mérhetően leírhatók, például

A leírás az olvasó igényeitől függően a mindössze néhány mondatot igénylő általános áttekintéstől a mechanizmus alkatrészeinek és funkcióinak minden részletét részletező, több fejezetből álló kézikönyvig terjedhet a műszaki problémák elhárítása és a javítások elvégzése érdekében. Ez utóbbira szórakoztató példaként lásd a Star Trek: The Next Generation: Műszaki kézikönyv (a 7.4.1. ábrán látható borító), amely részletes leírást ad a fiktív U.S.S. Enterprise-D fedélzetén használt összes berendezésről és technológiáról.

Mielőtt elkezdené megfogalmazni a leírását, át kell gondolnia a célját és a célközönséget: Miért van szüksége a közönségének erre a leírásra? Mire fogják használni? Az átlagfogyasztók számára írja le a különböző napelemtípusokat, hogy segítsen nekik kiválasztani az igényeiknek leginkább megfelelőt? Műszaki szakembereknek és szerelőknek ad vázlatterveket?

Ha már világosan megvan a cél és a célközönség, készítsen olyan leírást, amely a következő elemeket tartalmazza:

1. Meghatározás:
2. Áttekintés: Írja le a mechanizmus általános megjelenését (“nagy kép”).
3. Összetevők: Írja le a fő alkotóelemeket felcímkézett szakaszokban; itt gondosan vegye figyelembe az információk sorrendjét. Hozzon létre logikai kapcsolatot az egyes leírt alkatrészek között.
4. Magyarázat: Hogyan működnek együtt az alkatrészek a funkció betöltése érdekében? Milyen fő elvek határozzák meg a működését? Mérlegelje, hogy a célközönség számára itt mennyi részletességre van szükség.
5. Vizuális elemek: tartalmazzon olyan grafikákat, amelyek egyértelműen szemléltetik a mechanizmust és/vagy annak részeit. Mutassa be az eszközt egészében; fontolja meg a konkrét részletek bemutatását bővített nézetekben, kivágásokban vagy felcímkézett ábrákon. Akár beágyazhat vagy hivatkozhat az eszközt működés közben bemutató videókra is.
6. Következtetés: A céltól függően áttekintheti a termék történetét, elérhetőségét, gyártását, költségeit, figyelmeztetéseit stb.
7. Hivatkozások: A leírásban felhasznált források, illetve a rendelkezésre álló további információforrások (ha releváns).

Elképzelhető, hogy egy sablont használ, például az alábbi Műszaki leírás sablonját, szem előtt tartva, hogy bár a sablonok hasznos útmutatók lehetnek, nem nyújtanak nagy rugalmasságot, és nem biztos, hogy minden helyzetben működnek.

Mintaleírások

Vizsgálja meg a 7.4.2. ábrán a “Felmenő ötös” leírását (kattintson a képre a nagyobb változatért). Ki lehet a célközönség?

Hasonlítsa össze a 7. ábrán látható leírást.4.2. ábrát a NASA honlapján a Mars Curiosity Roverről megadott információkkal.

Nézze meg a részletesség, a szókincs és a leírások általános célja közötti különbségeket. Ha a NASA webhelyén található információkat használná a Műszaki leírás sablon kitöltéséhez, akkor az alábbi táblázathoz hasonló eredményt kaphatna. Célok

Lehet, hogy ezek közül néhány elemre nincs szükség; ismétlem, vegye figyelembe, mit tud már a célközönsége. Keresse meg az egyensúlyt a nyilvánvaló dolgok felesleges kimondása és az olvasóinak olyan ismeretek helytelen feltételezése között, amelyekkel ők nem rendelkeznek.

A leírás részleteinek és alkotóelemeinek finomításakor vegye figyelembe a következőket:

• Szervezet: Használjon logikai elvet a leírás rendszerezéséhez
  • Fentről lefelé (vagy alapozás felfelé)
  • Balról jobbra (vagy jobbról balra)
  • Kívülről kifelé (vagy kívülről befelé)
  • A legfontosabb a legkevésbé fontos jellemzőkhöz
  • Központi alkatrész a perifériákhoz
  • Materiális tulajdonságok stb.
• Nyelv: Használjon specifikus, pontos, konkrét kifejezéseket – kerülje a homályos vagy túlságosan általános kifejezéseket
  • Korrekt terminológiát használjon – a közönség számára szükséges módon határozza meg a kifejezéseket
  • Az analógiát használja, hogy egy ismeretlen dolgot egy ismerős dologra vonatkoztatva írjon le
  • A tárgyilagos nyelvezetet használja – ne használjon “reklámbeszédet” vagy szubjektív kifejezéseket
  • Kezdő időt használjon, aktív igékkel írja le, hogyan jelenik meg az eszköz, és mit csinál
  • Használjon olyan szavakat, amelyek élénk és konkrét képeket keltenek az olvasó fejében.

Válasszon ki egy hétköznapi, mindennapi tárgyat (például a 7.4.3. ábrán látható tárgyak egyikét), és készítsen műszaki leírást a tárgyat nem ismerő közönség számára. Kezdje azzal, hogy elképzeli a célközönséget és a célt, majd próbálja meg részletes információkkal kitölteni a Műszaki leírás sablonját. A sablonban szereplő információk felhasználásával készítsen egy 1-2 bekezdésből álló rövid leírást, és illesszen hozzá megfelelően feliratozott képanyagot.