Kérjük, kattintson ide, hogy segítsen David McMurrey webtárhely-költségeinek fedezésében:
Adományozzon bármilyen kisebb összeget, amennyit tud!
Az Online Technical Writing továbbra is ingyenes marad.
A leírás megírásakor az egyik legnagyobb akadály az lehet, hogy emlékezzünk arra, mit jelent a kifejezés ebben a kontextusban. Mindannyian meglehetősen tág értelemben használjuk a description szót, gyakorlatilag bármilyen megbeszélés vagy magyarázat megjelölésére. Ebben az összefüggésben azonban a kifejezés egy dolog fizikai jellemzőinek részletes tárgyalását jelenti. Ez olyan tényezők bemutatását foglalja magában, mint a szín, az alak, a méret, a tömeg, a magasság, a szélesség, a vastagság, a felület, a sűrűség, a tartalom, a gyártás során használt anyagok, és így tovább.
Például a következő mondat a szó ebben az értelmében nem tekinthető valódi leírásnak:
A számítógépes floppy lemez egy olyan eszköz, amelyet elektronikus adatok tárolására használnak.
Ez a mondat a funkciót vagy a célt magyarázza, de kevés vagy egyáltalán semmilyen fizikai részletet nem tartalmaz. A következő mondat azonban egyértelműen leírásnak tekinthető:
Az 1980-as években elterjedt számítógépes floppy lemez mérete 3,5 hüvelyk × 3,5 hüvelyk volt, vastagsága pedig körülbelül 1/8 hüvelyk.
Feltétlenül tekintse meg a fejezethez tartozó példaleírásokat.
A fejezet NotebookLM által generált infografikája
A leírás kontextusai
Ahogy korábban említettük, a leírás a műszaki írás gyakori eleme—csak nem egészen ugyanúgy, mint az utasítások. A leírások gyakran egy-két mondatként jelennek meg itt, egy bekezdésként ott, vagy máshol egy teljes szakaszként. A műszaki írás bizonyos típusai különösen hangsúlyozzák a leírást:
- Baleseti jelentések, amelyek részletes leírást igényelnek.
- Termékspecifikációk—olyan dokumentumok, amelyek egy új vagy módosított termék tervezését és jellemzőit írják le—bőségesen tartalmaznak leírást.
- Az utasítások gyakran igényelnek leírást annak érdekében, hogy az olvasók el tudják képzelni, mit csinálnak és mivel dolgoznak.
A leírások tartalma és szervezése
Az alábbiakban áttekintjük azokat a szakaszokat, amelyekkel általában a leírásokban találkozhat. Olvasás közben tekintse meg a példaleírásokat is.
Bevezetés. Gondosan tervezze meg a leírás bevezetését. Győződjön meg arról, hogy az alábbiak mindegyikét tartalmazza (nem feltétlenül ebben a sorrendben), amennyiben az adott leírásra vonatkoznak:
- Határozza meg a leírni kívánt konkrét tárgyat.
- Jelezze, milyen előismeretekre és háttértudásra van szüksége a közönségnek a leírás megértéséhez.
- Adjon általános leírást a tárgyról.
- Tartalmazzon áttekintést a leírás tartalmáról.
Háttér. Ha az a dolog, amelyet leír, valószínűleg nem ismerős az olvasók többsége számára, fontolja meg némi háttérinformáció hozzáadását, mielőtt belekezdene a tényleges leírásba. Ha például egy SGO/3 sűrűségmérőt kíván leírni nem szakértők számára, célszerű először ismertetni, hogy mi is ez az eszköz, mire szolgál, és a világ mely részén használják.
Az alkatrészek vagy jellemzők tárgyalása. A leírás fő része az egyes alkatrészek vagy jellemzők bemutatása. A leírt dolgot alkatrészekre, jellemzőkre vagy mindkettőre kell bontani. Az alkatrészek könnyen értelmezhetők: például egy fa ceruza grafitbélből, fa testből, radírból és fém klipszből áll. A jellemzők ezzel szemben olyan leírható tulajdonságok, amelyek nem alkatrészek: például a ceruza tömege, hossza, szélessége stb. Ha egy feltörekvő ingatlanvállalkozó lenne, és egy üres telket kellene leírnia a vállalati iratok számára, valószínűleg a jellemzői alapján tenné ezt: elhelyezkedés, alapterület, terepviszonyok, növényzet, közműellátás, és így tovább. (Tekintse meg a példák között a primitív kőkaparó leírását; annak egy része jellemzők, más része alkatrészek szerint van elrendezve!)
Miután a leírt dolgot alkatrészekre, jellemzőkre vagy mindkettőre bontotta, a következő feladata az egyes elemek leírása. Mechanikai tárgyak esetében jól működik, ha az alkatrészt annak meghatározásával kezdi, azaz elmagyarázza a funkcióját. Ezt követően az általánostól a konkrét felé haladva írja le az alkatrészt, felhasználva a megfelelő leírási forrásokat.
Vegye észre, hogy a leírásban más írásműfajokat is keverhet. Előfordulhat, hogy funkciókat magyaráz, fogalmakat definiál, vagy egy-egy folyamatot ismertet a leírás során. Ez nem jelent problémát mindaddig, amíg az elsődleges fókusz és a tartalom nagy része valóban leírás marad.
A kapcsolódó működés vagy folyamat tárgyalása. A leírás egy bizonyos pontján—gyakran a végén—hasznos lehet összefoglalni a leírt tárgyhoz kapcsolódó működést vagy folyamatot. Például, ha egy mechanikus ceruzát írt le, röviden elmagyarázhatja, hogyan használják. Ha egy hópelyhet írt le, ismertetheti azt a folyamatot, amelynek során kialakult.
A leírás forrásai
Amikor leírást ír, át kell gondolnia, milyen típusú leíró részleteket tud nyújtani. Előfordulhat, hogy a leírások ezen a téren meglehetősen gyengék. Használja az alábbi listát a leírás megtervezéséhez vagy egy már megírt leírás átnézéséhez. Gondolja végig, mely leíró részletkategóriákat tudja felhasználni, vagy az alábbi lista segítségével azonosítsa azokat, amelyeket még nem alkalmazott:
|
szín magasság szélesség alak tömeg anyagok felület elhelyezkedés rögzítési módszerek szag |
mélység mennyiség minta, kialakítás összetevők kor alrészek hossz felületkezelés hőmérséklet nedvességtartalom |
A leírások sematikus áttekintése. Ne feledje, hogy ez csupán egy tipikus vagy gyakori modell a tartalom és a szervezés tekintetében—számos más megoldás is lehetséges.
Egyéb szempontok
A leírások során valószínűleg felmerül, hogyan kezelje a számokat, rövidítéseket és szimbólumokat:
Számok. Ne feledje, hogy a műszaki írás megszegi néhány olyan szabályt, amelyeket korábbi írásórákon tanult meg. A műszaki írás kontextusában gyakran létfontosságúak a számok, és azt szeretnénk, hogy feltűnőek legyenek. Ez azt jelenti, hogy a folyó szövegben számjegyeket kell használni, amikor a szám pontos, mért vagy mérhető mennyiséget jelöl, illetve amikor kritikus értéket képvisel. Például az alábbi mondatokban fontos, hogy a számok pontosak:
A csésze átmérője 3 hüvelyk.
A plakát rögzítéséhez használjon 4 rajzszeget.
Ez azonban nem jelenti azt, hogy közömbös értékek esetén is számjegyeket kellene használni. Például az alábbi mondatban nincs különösebb jelentősége annak, hogy hány szakaszból áll a jelentés:
A jelentés négy fő szakaszt tartalmaz.
További részletekért lásd a numbers vs. words című szakaszt.
Egy leíró bekezdés felépítése. Általában a rész céljára vagy funkciójára vonatkozó állítással kezdődik, amelyet a leíró részletek követnek. A leíró részletek a leírás „forrásaira” támaszkodnak—például a színre, alakra, szélességre és magasságra.
Rövidítések. A műszaki írásban számítunk a rövidítések használatára. Alkalmazza őket bátran a leírásban. Ne feledje a rövidítések írásjelezésének szabályát—csak akkor tegyen pontot, ha a rövidítés egy szót alkot (például „in.”). Arra is ügyeljen, hogy a rövidítések ne kerüljenek közvetlenül a szám mellé (például „8 mm tape” vagy „8-mm tape”, de ne „8mm tape”).
Szimbólumok. Az utasításokban és leírásokban a szimbólumokkal kapcsolatos leggyakoribb probléma a hüvelyk és a láb használatával függ össze. Ha olyan asztalosmunkához ír utasításokat, ahol sok a láb és hüvelyk, használja a " (hüvelyk) és ' (láb) szimbólumokat. Ha azonban csak néhányszor hivatkozik ezekre a mértékegységekre, inkább a szót vagy a rövidítést használja.
Grafikák és formátum a leírásokban
A legtöbb leírásban legalább egy illusztrációra szükség lesz a leírt tárgyról, a részekre mutató feliratokkal. A grafikák készítéséről, formázásáról és a leírásokba való beillesztéséről további információt a graphics szakaszban talál.
Címsorok. A leírásokban címsorokat és alcímsorokat célszerű használni az egyes alkatrészek vagy jellemzők tárgyalásának elkülönítésére. Ideális esetben minden alkatrészt külön bekezdésben vagy szakaszban kell leírni—és ezt egy címsorral kell jelezni. Ha van háttérszakasz, ahhoz is használjon címsort. A pontos követelményekért lásd a headings szakaszt.
Listák. A listák nem olyan fontosak a leírásokban, mint az utasításokban. Ugyanakkor, ha alkatrészeket, alrészeket vagy specifikációkat sorol fel, ezek jó alkalmak a listák használatára. A konkrét követelményekért lásd a lists szakaszt.
Különleges figyelmeztetések. A leírásokban a különleges figyelmeztetések nem töltenek be olyan fontos szerepet, mint az utasításokban. Hiszen ha valóban leírásról van szó, az olvasóknak nem kell semmilyen eljárást követniük, így nem fenyegeti őket annak veszélye, hogy berendezéseket károsítsanak, anyagokat pazaroljanak el, elrontsák az eljárást, vagy saját magukat vagy másokat megsértsenek. Ennek ellenére a note jellegű különleges figyelmeztetés hasznos lehet fontos pontok vagy kivételek kiemelésére. A megfelelő használatról, formátumról és az utasításokon belüli elhelyezésről szóló teljes ismertetést lásd a special notices szakaszban.
Örömmel fogadom észrevételeit, reakcióit és kritikáit ezzel a fejezettel kapcsolatban: válasz—David McMurrey
