Ellenőrizze a tartalmat
Az egyik legfontosabb módja annak, hogy átnézd a vázlatot, a tartalom ellenőrzése—milyen nyilvánvaló ez! Az összes jó átmenet, jó szervezés és világos mondatszerkezet a világon nem segíthet egy technikai dokumentumban, amelynek nincs megfelelő tartalma. A technikai dokumentum tartalma "hibás" lehet többféleképpen:
- Teljesen hiányozhat: például képzelj el egy olyan helyzetet, ahol valaki írt egy jelentést a "virtuális közösségekről", de soha nem törődött azzal, hogy meghatározza, mit is jelent ez a kifejezés. Nehéz lenne az elejétől kezdve.
- Ott van, de nem elég belőle: vegyük ugyanazt a példát — képzeljük el, hogy a szerző csak néhány homályos megjegyzést tett a virtuális közösségekről. Legalább egy bekezdésre szükség lett volna a témában, ha nem egy teljes, 3- vagy 4oldalas szakaszra.
- Ott van, de a közönség számára nem megfelelő szinten: Lehet információt a megfelelő szintnél alacsonyabb vagy magasabb szinten is közvetíteni az olvasók tudása, háttere vagy igényei szempontjából. Képzeljük el, hogy a szerző valóban tartalmazott egy 3 oldalas szakaszt az adatok gyorsítótárazásáról, de azt a termékfejlesztő (egy "szakértő" közönség számára) írta, miközben a jelentés valójában nem szakértőknek készült.
Ha érzékelni tudod, mennyire hiányos az információ egy jelentés vázlatában, akkor jó úton jársz ahhoz, hogy tudd, konkrétan mit kell tenned a javításhoz. Egy hasznos agytröszt eszköz az, ha a következőkre gondolsz: típusok tartalom.
Használja a megadott kérdéseket a dokumentum tartalma áttekinteni a vázlatodat, hogy milyen információkat érdemes hozzáadni vagy megváltoztatni.
Ellenőrizd a tartalmaid szerkezetét.
Két módja van a dokumentumban lévő információk megszervezésének:
- egy, amelyet a következő részben tárgyalunk, a információtöredékek sorrendjének megvizsgálását jelenti, hogy megállapítsuk, helyes sorrendben vannak-e.
- Egy másik a tájékoztatás szintjeivel foglalkozik. Megnézheti a mondatokat vagy bekezdéseket egy vázlatban, és láthatja, hogy egyes mondatok mélyebb szintű megvitatást nyújtanak a témáról, mint mások. Más mondatok mint keretrendszer működnek, amelyekre ezek a mélyebb szintű mondatok támaszkodnak. Ha így vizsgálja a struktúrát, nemcsak annak szervezését ellenőrzi, hanem sok jó ötletet is kap arra vonatkozóan, hogyan lehetne javítani a szöveg tartalmát.
Sokkal részletesebb magyarázat található itt: koordináció és alárendelés bekezdésekben.
Ellenőrizze a szervezetet
Ha a jelentésedben a megfelelő tartalom van, legalábbis megvan az összes "helyes dolog" az olvasók számára. Azonban még mindig lehet, hogy nem eléggé van rendezve—mint amikor éppen költöztél, és minden káoszban van vagy még dobozokban. Két alapvető készségre van szükséged a vázlat szervezésének felülvizsgálatához:
- Az információk különböző szintjein lévő darabok témájának azonosítása. A bekezdések szervezésének értékeléséhez először gondolj egy szóra vagy kifejezésre, amely az egyes bekezdések témáját azonosítja—más szóval, ragadd meg mindegyiket. Ezután hátraléphetsz ezektől a szavaktól vagy kifejezésektől, és megfontolhatod, hogy a megfelelő sorrendben vannak-e. Ez azonban csak egy szint. Nézheted másképp is belül egyéni bekezdés a szervezéséről. Ebben az esetben azonosítod minden mondat témáját és figyelembe veszed azok sorrendjét.
- Válaszd ki a legjobb sorrendet az információs darabokhoz. Miután tudod, mi a téma mindegyik információs részletnek (bármilyen szinten is vizsgálod), eldöntheted, hogy a megfelelő sorrendben vannak-e. Ez a döntés magában foglalja a gyakori sorrendi minták ismeretét; itt van néhány példa:
- Általános → specifikus: Egy gyakori módja a szervezésnek, hogy a tartalom darabjait általánostól a specifikusig csoportosítjuk. Például meghatározva minden A napkollektorok általánosabb téma, mint a napkollektorok különböző típusainak megvitatása. Egy konkrét napkollektor működésének leírása pedig még kevésbé általános. Ez a minta itt látható:
Áttekintés általánosból specifikusba szervezési minta szerint. Természetesebb fejlődés, ha azzal kezdjük, hogy meghatározzuk, mit csinálnak a napkollektorok, majd áttérünk a különböző típusokra. - Egyszerű, alap → komplex: Egy másik módja a megbeszélés egységeinek elrendezésére, hogy a egyszerű, alapvető, fundamentális elemekkel kezdjük, majd áttérünk a bonyolultabb és technikai jellegűekre.
- Nyugalomban lévő dolog → mozgásban lévő dolog: Egy másik szervezési minta az, hogy először leírjuk a dolgot (mintha egy fényképen lennénk), majd beszélünk a működéséről vagy folyamatáról (mintha egy videóban lennénk). Ez a megközelítés jól működhet egy üzemanyag-befecskendező rendszer megbeszélése során.
- Térbeli mozgás: — Ha valaminek a fizikai részleteit írod le, érdemes lehet valamilyen fizikai mozgásmintát használni, például felülről lefelé, balról jobbra vagy kívülről befelé.
- Időbeli mozgás: — Az egyik leggyakoribb minta az időbeli mozgáson alapul; a események megbeszélését a temporális sorrendhez kell igazítani.
- A → koncepció alkalmazása, példákEgy gyakori szervezeti minta az, hogy egy fogalmat általános szempontból tárgyalunk, majd annak alkalmazásáról beszélünk. Például ennek a könyvnek egy másik fejezete először elméletben tárgyalja a javaslatokat, majd példákat hoz fel a javaslatokból.
- Adatok → következtetések: Az információk másik megszervezési módja az, hogy bemutatjuk az adatokat (megfigyelések, kísérleti adatok, felmérési eredmények), majd áttérünk azokra a következtetésekre, amelyek levonhatók ezekből az adatokból. (És ez a minta néha megfordul: először bemutatjuk a következtetést, majd az ahhoz támogató adatokat.)
- Probléma, kérdés → megoldás, válasz: Az információt úgy is megszervezheted, hogy először egy problémát vitatsz meg vagy egy kérdést teszel fel, majd áttérsz a megoldásra vagy válaszra.
- Egyszerűsített verzió → részletes verzió: Hasznos módja a technikai kérdések nonspecialisták számára történő magyarázásának, ha egy egyszerűsített verzióval kezdjük, megszilárdítjuk a megértést, majd visszatérünk, és mindent újra elmagyarázunk, de ezúttal a technikai részleteket vastagon és nehezen tálalva!
- Legfontosabb → legkevésbé fontos: Egy "retorikai" módszer a szervezésre az, hogy a legfontosabb, legszembetűnőbb, legdrámaibb információval kezdjük, majd fokozatosan áttérünk a kevésbé figyelemfelkeltő információkra. (Ez a minta visszafelé is fordítható: felépítheted a csúcspontot, ahelyett, hogy azzal kezdenél.)
- Legmeggyőzőbb → legkevésbé meggyőző: — Hasonlóképpen, a legmeggyőzőbb érvet kezdheti el a pozíciója mellett — hogy felkeltse mindenki figyelmét — majd áttérhet a kevésbé meggyőző érvekre. (Ez a séma meg is fordítható: építheti a legmeggyőzőbb érveire.)
- Általános → specifikus: Egy gyakori módja a szervezésnek, hogy a tartalom darabjait általánostól a specifikusig csoportosítjuk. Például meghatározva minden A napkollektorok általánosabb téma, mint a napkollektorok különböző típusainak megvitatása. Egy konkrét napkollektor működésének leírása pedig még kevésbé általános. Ez a minta itt látható:
Ez csak néhány lehetőség. Amikor a cél tájékoztató, az információkat úgy rendezed el, hogy biztosítsd, hogy az olvasók megértsék az alapokat, mielőtt a bonyolult, technikai részletekre térnél. Amikor a cél meggyőző, akkor a dolgokat úgy rendezed el, hogy maximalizáld a meggyőző hatást az olvasókra, például a legerősebb érveket előre helyezve.
És bármilyen esetben kerüld el, hogy össze tedd ezeket a megközelítéseket—például úgy, hogy kidobsz néhány adatot, majd néhány következtetést állítasz, aztán ezt véletlenszerű módon váltogatod. Tartsd az almákat külön a narancsoktól!
Erősítse meg a téma mondatokat és az áttekintéseket
Az egyik legjobb dolog, amit tehetsz, hogy visszatérsz egy vázlathoz, és megnézed, tudsz-e témakötéseket és áttekintéseket beilleszteni kulcspontokon. Amikor írunk, általában nem vagyunk biztosak abban, hogy egy bekezdés vagy szakasz pontosan hová tart a tartalma és logikája alapján. Miután "eljutott oda," gyakran szükséges visszamenni az elejére, és valamilyen áttekintést hozzáadni, vagy módosítani, ami már ott van, hogy az áttekintés világosabb legyen. Az olvasóknak tudniuk kell, hová tartanak egy jelentésben, mi jön a következő lépésben, és egyébként, hogy hol jártak éppen.
Egy jelentés áttekintése olyan, mint egy térkép, amikor új városban vagy. A téma mondatok és áttekintések perspektívát nyújtanak arról, hogy mi hol található: a téma, a szemprelő témák, a közelgő vita célja, annak kapcsolata az előző szekcióval és az egész dokumentummal. (Most ennek egy része átmeneteket érint, ami a következő elem, amit át kell nézni.)
A téma részletes tárgyalásához lásd témakidészek és áttekintések.
Erősítse a koherenciát, a folyamatosságot.
Lehet, hogy a jelentésben megfelelő információkat adsz, és jól is rendezve van, de valami fontos akkor is rosszul sült el. Az olvasók esetleg elveszíthetik az "áramlását" az ötleteknek, és nehezen érzékelhetik, hogy az információdarabok hogyan kapcsolódnak egymáshoz. Amit az olvasóknak szükségük van, az a folyamatos irányítás—amit te, mint író, nyújtasz. És amit használsz ennek az irányításnak a biztosításához, az a átmenetek—különböző eszközök, amelyek segítik az olvasókat a dokumentumon keresztül. Van (vagy bizonyosan kell legyen) egy logika, amely összeköti a dokumentum minden mondatát, és amely előír egy bizonyos sorrendet ezen mondatok számára.
Lásd a fejezetet a koherencia és átmenetek részletes megbeszéléshez és példákhoz.
Ellenőrizze a bekezdés hosszát.
Az utolsó módja annak, hogy átnézd a vázlatodat a struktúra szintjén, az, hogy ellenőrzöd, hogyan definiáltad a bekezdések törését. A bekezdések különös lények—egyes íráskutatók szerint nem léteznek, és csupán önkényes töréspontok, amelyeket az írók akkor és ott dobnak be, amikor és ahol csak akarják. Sajnálom—a technikai írásban a bekezdés kulcsszereplő a világosság és megértés harcában. Bár nem mindig lehetséges, a bekezdéseknek ott kellene előfordulniuk, ahol valamilyen témaváltás vagy az alkotémában történt elmozdulás van, vagy ahol a téma megvitatásának módjában történik elmozdulás.
Egy egysoros egy teljes oldalnyi írásban keress legalább egytől négy bekezdés megszakítást—nincs semmi varázslatos abban az átlagban, ezért ne úgy bánj vele, mintha törvény lenne. Csak egy második pillantást vess a hosszú bekezdésekre, és nézd meg a bekezdés megszakítások lehetőségét.
Értékelném a gondolataidat, reakcióidat, kritikáidat ezzel a fejezettel kapcsolatban: a te válaszod—David McMurrey.
