Skontrolujte obsah
Jedným z najdôležitejších spôsobov, ako môžete nezrozumiteľný návrh skontrolovať, je skontrolovať obsah—ako zrejmé je to! Všetky dobré prechody, dobrá organizácia a jasná štruktúra viet na svete nemôžu pomôcť technickému dokumentu, ktorý nemá správny obsah. Obsah technického dokumentu môže byť "nesprávny"v niekoľkých ohľadoch:
- Môže úplne chýbať: napríklad si predstaviť, že niekto napísal správu o "virtuálnych komunitách", ale nikdy sa nezamyslel nad tým, čo tento termín znamená. Od začiatku tejto správy by to bolo ťažké.
- Je to tam, ale nie je toho dosť: vezmite ten istý príklad—predstavte si, že autor urobil len niekoľko vágnych vyhlásení o virtuálnych komunitách. To, čo bolo potrebné, bol aspoň jeden odsek na túto tému, ak nie celý 3- alebo 4-stranový úsek.
- Je tam, ale na nesprávnej úrovni pre publikum: Je tiež možné prezentovať informácie na nesprávnej úrovni z hľadiska znalostí, pozadia alebo potrieb čitateľov. Predstavte si, že autor skutočne zahrnul 3-stranovú časť o ukladani dát, ale napísal ju pre odborníkov na vývoj produktov ("expert"), keď bol správa skutočne určená pre nešpecialistov.
Ak máte pocit, že informácie sú v návrhu správy nedostatočné, mali by ste byť na dobrej ceste k tomu, aby ste vedeli, čo konkrétne urobiť na revíziu. Jedným užitočným nástrojom na brainstormovanie je premýšľať v termínoch typy obsahu.
Použite otázky poskytnuté v obsah dokumentu na prehodnotenie vášho hrubého návrhu ohľadom typov informácií, ktoré pridať alebo zmeniť.
Skontrolujte štruktúru svojho obsahu.
Existujú dva spôsoby, ako sa pozerať na organizáciu informácií v dokumente:
- jedna, pokrytá v nasledujúcej sekcii, zahŕňa skúmanie sekvencie blokov informácií a zisťovanie, či sú v správnom poradí.
- Ďalší sa týka úrovní informácií. Môžete sa pozrieť na vety alebo odstavce v hrubom náčrte a vidieť, že niektoré vety sa zaoberajú hlbšou úrovňou diskusie na tému ako iné. Iné vety pôsobia ako rámec, na ktorom závisia tie hlbšie úrovňové vety. Tým, že sa na štruktúru pozeráte týmto spôsobom, nielenže kontrolujete jej organizáciu, ale získavate aj veľa dobrých nápadov, ako zlepšiť obsah textu.
Veľa podrobnejšie vysvetlenie je poskytnuté na koordinácia a subordinácia vo odsekoch.
Skontrolujte organizáciu
Ak máte v správe správny obsah, aspoň máte všetko "správne veci" k dispozícii pre čitateľov. Môže však byť stále nedostatočne organizovaný—ako keď ste sa práve presťahovali a všetko je v chaose alebo stále v krabiciach. Potrebujete dve základné zručnosti na preskúmanie organizácie hrubého náčrtu:
- Identifikujte tému kusov informácií na rôznych úrovniach. Aby ste posúdili organizáciu súboru odsekov, začnete premýšľať o slove alebo fráze, ktorá identifikuje tému každého odseku — inými slovami, získať prehľad o každom z nich. Potom sa od týchto slov alebo fráz vzdialite a zvážite, či sú v správnom poradí. Avšak to je len jedna úroveň. Môžete sa tiež pozrieť vnútri individuálny odsek pre jeho organizáciu. V tomto prípade identifikujete tému každého veta a zvážite sekvenovanie týchto viet.
- Vyberte najlepšiu sekvenciu pre úseky informácií. Akonáhle poznáte tému každého zúženej informácie (na akejkoľvek úrovni, ktorú skúmate), môžete sa rozhodnúť, či sú v správnom poradí. Toto rozhodnutie zahŕňa poznanie bežných sekvenčných vzorov; tu je niekoľko príkladov:
- Všeobecné → špecifické: Bežný spôsob organizácie je usporiadať časti obsahu od všeobecného po konkrétne. Napríklad, definovanie všetko Diskusia o solárnych kolektoroch je všeobecnejšia než diskusia o rôznych typoch solárnych kolektorov. A popis fungovania konkrétneho typu solárneho kolektora je ešte menej všeobecný. Tento vzor je ilustrovaný tu:
Revízia so všeobecným až špecifickým organizačným vzorom. Je prirodzenejším postupom začať definovaním toho, čo všetky solárne kolektory robia, a potom prejsť na ich rôzne typy. - Jednoduchý, základný → komplex: Ďalší spôsob, ako usporiadať jednotky diskusie, je začať s jednoduchými, základnými, fundamentálnymi a potom prejsť k zložitejším a technickejším.
- Vec-ubehnutá → vec-v pohybe: Ďalší organizačný vzor zahŕňa najprv opísanie veci (ako na fotografii), potom diskusiu o jej fungovaní alebo procese (ako vo videu). Tento prístup by mohol byť vhodný na diskusiu o systéme vstrekovania paliva.
- Priestorový pohyb: — Ak popisujete fyzické detaily niečoho, možno by ste chceli použiť nejaký vzor fyzického pohybu, napríklad zhora nadol, zľava doprava alebo zvonka dovnútra.
- Dočasný pohyb: — Jeden z najbežnejších vzorov je založený na pohybe v čase; usporiadajte diskusiu o udalostiach v súvislosti s časovou sekvenciou.
- Koncept → aplikácia konceptu, príkladyBežným organizačným vzorom je najprv diskutovať o koncepte vo všeobecných pojmoch a potom sa zaoberať jeho aplikáciou. Napríklad, iná kapitola v tejto knihe najprv diskutuje o návrhoch koncepčne a potom sa zaoberá príkladmi návrhov.
- Dáta → závery: Ďalším spôsobom organizovania informácií je prezentovať údaje (pozorovania, experimentálne údaje, výsledky prieskumov) a potom prejsť k záverom, ktoré možno z týchto údajov vyvodiť. (A tento vzor je niekedy obrátený: najprv sa prezentuje záver, potom údaje, ktoré ho podporujú.)
- Problém, otázka → riešenie, odpoveď: Môžete tiež organizovať informácie tak, že najprv prediskutujete problém alebo vznesiete otázku a potom prejdete k riešeniu alebo odpovedi.
- Zjednodušená verzia → podrobná verzia: Užitočný spôsob, ako vysvetliť technické záležitosti nespecialistom, je začať diskusiou o zjednodušenej verzii danej veci, vytvoriť si o nej pevnú predstavu, a potom sa k nej vrátiť a všetko znovu vysvetliť, ale tentokrát s bohatými a podrobnými technickými detailmi!
- Najdôležitejšie → najmenej dôležité: Menej "rétorický" spôsob organizácie je začať s najdôležitejšími, najpôsobivejšími, najdramaticnejšími informáciami ako prvými a následne prejsť na informácie, ktoré sú postupne menej významné. (A tento vzor môže byť obrátený: môžete vybudovať k vyvrcholeniu, namiesto toho, aby ste s ním začali.)
- Najpresvedčivejšie → najmenej presvedčivé: — Podobne môžete začať s najpresvedčivejším argumentom pre svoju pozíciu — aby ste upútali pozornosť všetkých — a potom prejsť na menej a menej presvedčivé. (Tento vzor môže byť tiež obrátený: môžete sa postupne dostávať k svojim najpresvedčivejším argumentom.)
- Všeobecné → špecifické: Bežný spôsob organizácie je usporiadať časti obsahu od všeobecného po konkrétne. Napríklad, definovanie všetko Diskusia o solárnych kolektoroch je všeobecnejšia než diskusia o rôznych typoch solárnych kolektorov. A popis fungovania konkrétneho typu solárneho kolektora je ešte menej všeobecný. Tento vzor je ilustrovaný tu:
Toto sú iba niektoré možnosti. Keď je cieľom informovať, usporiadate informácie tak, aby ste zabezpečili, že čitatelia pochopia základy predtým, ako prejdú k zložitým, technickým veciam. Keď je cieľom presvedčiť, usporiadate veci tak, aby ste maximalizovali presvedčivý efekt na čitateľov, napríklad tým, že najprv uvediete najstrongšie argumenty.
A v každom prípade sa vyhnite kombinovaniu týchto prístupov—napríklad, vyhadzovaniu niektorých údajov, potom uvedeniu niekoľkých záverov a potom sa k tomu vracaniu rôznymi spôsobmi. Držte jablká oddelené od pomarančov!
Posilnite témy viet a prehľady
Jednou z najlepších vecí, ktoré môžete urobiť, je prejsť si hrubý náčrt a skontrolovať, či môžete vložiť témy a prehľady na kľúčových miestach. Keď píšeme, zvyčajne nie sme si úplne istí, kam presne ide odsek alebo sekcia z hľadiska obsahu a logiky. Keď sa dostane tam, často je potrebné vrátiť sa na začiatok a pridať nejaký prehľad alebo modifikovať to, čo už tam je, aby bol prehľad jasnejší. Čitatelia potrebujú vedieť, kam smerujú v správe, čo sa chystá ďalej, a mimochodom, kde práve boli.
Mať prehľad v správe je ako mať mapu, keď ste v novom meste. Tématické vety a prehľady ponúkajú pohľad na to, čo je kde: téma, podtémy, účel nadchádzajúcej diskusie, jej súvislosť s predchádzajúcou sekciou a dokumentom ako celkom. (Niektoré z toho sa týkajú prechodov, čo je ďalší prvok na preskúmanie.)
Pre podrobné spracovanie tejto témy, pozrite sa na témy a prehľady.
Posilniť koherenciu, prechody
Môžete mať správne informácie v správe a mať ich správne usporiadané, ale niečo dôležité sa stále môže pokaziť. Čitatelia môžu zmeškať "tok" myšlienok, môžu mať ťažkosti s vnímaním toho, ako sú kusy informácií navzájom súvisiace alebo prepojené. Čo čitatelia potrebujú, je nepretržité usmerňovanie—, ktoré im poskytujete vy, pisateľ. A to, čo používate na poskytovanie tohto usmernenia, sa nazýva prechody—rôzne prostriedky, ktoré pomáhajú čitateľom prechádzať dokumentom. Existuje (alebo určite by mala existovať) logika, ktorá spája každú vetu v dokumente a ktorá určuje určitú sekvenciu týchto viet.
Pozri kapitolu o koherencia a prechody na podrobné diskusie a príklady.
Skontrolujte dĺžku odseku.
Jedným posledným spôsobom, ako si prekontrolovať hrubý náčrt na úrovni štruktúry, je skontrolovať, ako ste definovali odsekové prestávky. Odseky sú zvláštne bytosti—niektorí vedci písania veria, že neexistujú a sú len náhodnými prestačkami, ktoré autori vhodia kedykoľvek a kdekoľvek sa im zachce. Prepáčte—v technickom písaní je odsek kľúčovým hráčom v boji za jasnosť a porozumenie. Hoci to nie je vždy možné, odseky by sa mali vyskytovať tam, kde dochádza k nejakému posunu v téme alebo podtéme alebo k nejakému posunu v spôsoboch, akými sa téma diskutuje.
Na jednej stránke s jedným riadkom medzi odsekmi hľadajte aspoň jeden až štyri prestupy odsekov—nie je na tom priemere nič magického, takže to netreba považovať za zákon. Stačí sa pozrieť na tie dlhé odseky a skontrolovať možnosti prestupov odsekov.
Ocenil by som vaše myšlienky, reakcie a kritiku týkajúcu sa tejto kapitoly: vaša odpoveď—David McMurrey.
