Táto stránka je úplne v priebehu výstavby!
Technická správa je ťažké definovať—je to nie veľa vecí, ale ťažko sa povie, čo to je je. Neposkytuje krok-za-krokom pokyny, ako niečo urobiť, tak ako to robia inštrukcie. Formálne neponúka odporúčania, ako to robia správy o uskutočniteľnosti. Neuvádza údaje z pôvodného výskumu a nevytvára závery tak, ako to robia správy o primárnom výskume.
Čo teda robí technická správa? Poskytuje informácie o technickej téme, ale takým spôsobom, ktorý je prispôsobený pre konkrétne publikum, ktoré má špecifické potreby pre tieto informácie. Predstavte si tému ako je: renálne ochorenie a terapia. Technická správa o tejto téme by nie vydumpovať desaťtonovú učebnicu obsahujúcu všetko, čo by ste mohli o tom povedať. Vyberie informácie o téme prispôsobené konkrétnej skupine čitateľov, ktorí mali konkrétne potreby a využitie pre informácie. Predstavte si, že publikom bola skupina inžinierov, ktorí sa uchádzali o zmluvu na časť práce pre kliniku dialýzy. Áno, potrebujú vedieť o ochorení obličiek a jeho terapii, ale len do tej miery, ktorá sa týka ich oblastí odbornosti. Takáto správa na pozadí by mohla tiež obsahovať základnú diskusiu o ochorení obličiek a jeho liečbe, ale nie viac, ako inžinieri potrebujú na vykonávanie svojej práce a na interakciu s predstaviteľmi kliniky.
Pozrite sa na príklady technické správy pozadia.
Jeden z reportov je prieskum globálneho otepľovania, alebo skleníkového efektu, ako sa nazýva v správe. Všimnite si, že sa zaoberá príčinami, potom skúma účinky a nakoniec diskutuje o tom, čo sa s tým dá robiť.
Obsah a organizácia technických podkladových správ
Na rozdiel od väčšiny ostatných správ, ktoré sú uvedené v tomto sprievodcovi kurzom, technická backgroundová správa nemá spoločný súbor obsahu. Pretože sa zameriava na konkrétne technické témy pre špecifické publikum, ktoré má konkrétne potreby alebo využitie informácií, uchopuje akýkoľvek typ obsahu, ktorý potrebuje na splnenie úlohy. Pri plánovaní tohto typu správy používate veľa intuície. Napríklad, v správe o renálnych chorobách a liečbe by ste pravdepodobne chceli diskutovať o tom, čo je renálna choroba, čo ju spôsobuje, ako sa lieči a aké technológie sú zapojené do liečby. Ak svojej intuícii úplne neveríte, použite zoznam úloh ako nasledujúci:
- Definície—Definujte potenciálne neznáme pojmy súvisiace s témou. Napíšte predĺžený definície, ak sú kľúčové pojmy alebo ak sú obzvlášť ťažké na vysvetlenie.
- Príčiny—Vysvetlite, aké príčiny súvisia s danou témou. Napríklad, pri téme ochorení obličiek, aké príčiny spôsobujú toto ochorenie?
- Účinky—Vysvetlite, aké sú následky, výsledky alebo účinky spojené s danou témou. V tému ochorenia obličiek, čo sa deje s ľuďmi, ktorí trpia týmto ochorením; aké účinky majú rôzne liečby?
- Typy—Diskutujte o rôznych typoch alebo kategóriách spojených s touto témou. Napríklad, existujú rôzne typy ochorení obličiek; existujú rôzne kategórie liečby?
- Historický kontext—Diskutujte o relevantnej histórii súvisiacej s touto témou. Diskutujte o ľuďoch, udalostiach a minulých teóriách súvisiacich s touto témou.
- Procesy—Diskutujte mechanické, prírodné a ľudsky riadené procesy súvisiace s témou. Vysvetlite krok za krokom, ako proces prebieha. Napríklad, aké sú fázy cyklu ochorenia obličiek; čo sa zvyčajne stane osobe so špecifickou formou ochorenia?
- Popisy—Poskytnite informácie o fyzikálnych podrobnostiach vecí súvisiacich s témou. Poskytnite informácie o veľkosti, tvare, farbe, hmotnosti a podobne. Pre technickú dokumentáciu orientovanú na inžinierstvo to znamená veľkosť, energetické požiadavky a ďalšie podobné detaily o technológiách spracovania.
- Porovnania—Porovnajte tému, alebo niektorý jej aspekt, s niečím podobným alebo známym. V príklade s ochorením obličiek by ste mohli porovnať ochorenie obličiek s iným ochorením; liečbu s nejakou liečbou; funkcie obličky s niečím známym (analógia); alebo dokonca liečbu s niečím známym, napríklad so systémom filtrácie pre bazén.
- Žiadosti—Preskúmajte, ako sa niektorý aspekt vašej témy môže využiť alebo aplikovať. Ak ide o nejakú novú technológiu, aké sú jej aplikácie?
- Výhody a nevýhody—Diskutujte o výhodách alebo nevýhodách jedného alebo viacerých aspektov vašej témy. V téme ochorenia obličiek, napríklad, aké sú výhody jednej liečby oproti inej?
- Ekonomické úvahy—Diskutujte náklady na jeden alebo viac aspektov súvisiacich s vašou témou. Aké sú náklady na liečbu ochorení obličiek? Aké sú náklady na vybavenie a personál?
- Sociálne, politické, právne, etické dôsledky—Preskúmajte dôsledky alebo dopad vašej témy alebo niektorej jej stránky v súvislosti so sociálnymi, politickými, právnymi alebo etickými otázkami. Príklad obličkového ochorenia sa na túto oblast veľmi nehodí, ale predstavte si možnosti s témou ako je kryogenika—pozastavená animácia ľudí. Často majú nové technológie hlboký dopad v týchto oblastiach.
- Problémy, otázky—Aké problémy alebo otázky sú spojené s vašou témou technickej dokumentácie alebo niektorým jej aspektom?
- Riešenia, odpovede—Aké riešenia alebo odpovede môžete ponúknuť na problémy alebo otázky, ktoré vyvstali vo vašej téme alebo v niektorých jej aspektoch?
Môžeme pridať mnoho ďalších kategórií do kontrolného zoznamu ako je tento, ale možno je to dosť na to, aby ste začali plánovať obsah vašej správy o technickom zázemí. A nezabudnite, že každý z týchto položiek kontrolného zoznamu môže predstavovať celú sekciu v správe—nie vetu alebo dve.
Pokiaľ ide o usporiadanie týchto častí správy, opäť sú vaše intuície v poriadku. Niektoré podtémy prirodzene prichádzajú pred iné. Pozrite sa na kapitolu o organizačné vzory a aplikovať ich.
Formát technických pozadí správ
Táto kapitola vás prevedie od prednej obálky až po poslednú stránku tohto typu správy, ukazujúc očakávaný obsah a formát. Pamätajte, že vo väčšine kurzov technického písania sa očakáva, že budete používať tento formát presne a presne—pokým sa nedohodnete na iných podmienkach so svojím lektorom.
Súvisiace informácie
Čítací kvíz. Použite tento kvíz na overenie svojho porozumenia tejto kapitole.
K dispozícii je školenie. Získajte nejakú prax v písaní s McMurrey ako váš inštruktor.
Ocenil by som vaše myšlienky, reakcie, kritiku týkajúcu sa tejto kapitoly: vaša odpoveď—David McMurrey.
