Clarity of technical reporting

Clarity of technical reporting – NASA SP – 7010

Když píšete každé slovo, frázi nebo větu, otažte se vždy, zda je jejich význam jasný, anebo je možné, aby byly v dané souvislosti špatně pochopeny.

Shledáváte-li, že se váš odstavec stává příliš dlouhým, buď zjednodušte celkovou myšlenku nebo tuto myšlenku rozdělte na menší části, tak aby každé odpovídal zvláštní odstavec.

Zpráva o experimentálním výzkumu

Úvod

• Může být napsán ve zcela přímém a stručném stylu.
• Můžete začít popisovat pozadí a motivy, které vedly ke vzniku problému a objasňují jeho význam.
• Při takových a takových pracích vznikly ty a ty problémy. V literatuře (1) byly studovány ty a ty fáze problému, literatura (2) obsahuje jiné další aspekty. Výsledky však ponechávají stále neřešenou otázku …
• Zůstává hlavní základní problém … takže dnes není možno konstatovat …
• Když jste ukázali, v čem problém tkví, anebo všeobecně jaké jsou jeho příčiny, uveďte nyní zhruba, co mělo být příspěvkem vašemu výzkumu a podle jakých zásad jste postupovali.
• Ve snaze získat detailnější pohled na … byla provedena experimentální studie … s zvláštním důrazem na … Materiál, který byl k dispozici, byl považován za zvlášť vhodný, protože …
• Dále byl sestrojen zvlášť pro tyto účely zvláštní stroj, v jehož možnostech bylo … takže byl schopen dodat informace (dosud nedosažitelné) takového a takového typu.
• Váš čtenář má nyní hrubý přehled, o co jste se vlastně pokoušel a proč. Je vhodné v tomto okamžiku připojit konečnou část úvodu, v níž uvedete přesněji jaké druhy zkoušek a rozborů byly provedeny, rozsah uvažovaných proměnných a podobné informace, které šířeji definují povahu a rozsah vaší práce. Čtenář tak získá přehled o celkovém rozsahu a úplnosti vaší práce a bude vědět, co může z vaší zprávy očekávat.
• Většinou 3 odstavce, ale i více nebo zase jen jeden.

Přístroje a měření – popis

Výsledky a diskuze

• Zvlášť nebo dohromady podle povahy
• Vzpomeňte si, že v úvodu jste popsali problém a cíl, který jste chtěli vaší prací dosáhnout. Tento úvod mějte na mysli, když pak uvádíte získané hodnoty a ukažte ve své diskuzi, jak tyto hodnoty vrhají světlo na problém a nebo do jaké míry byly vaše původně zamýšlené cíle dosaženy. Někteří autoři považují za vhodné sestavit seznam hlavních bodů, které jsou výsledky výzkumu a potom objasňují jednotlivé body.
• Ať si zvolíte postup jakýkoli, podstatné je držet se určitých zásad. Nepřebíhat! Vyvarovat se trivialit! 

Závěr

• V podstatě uvádí (zřídkakdy více než ve 2 větách), co jste svým výzkumem dosáhli.
• „Tak, udělal jste kus práce ve výzkumu. A co jste tedy vlastně udělal?“ Nemá se odvolávat na hlavní část.
• Někdy je vyjmenování konkrétních závěrů prakticky nemožné. V tom případě pod kapitolu „Závěry“ by měly být uvedeny: Krátká diskuze problému, to, co jste během výzkumu poznali a co očekáváte od předmětu vaší práce. Někdy se též stane, že původní problém zůstává v podstatě nevyřešen (nedostačující technika, získané informace méně užitečné, než se původně očekávalo).
• Přímá a otevřená diskuze spolu s návrhy na další výzkumy je v takových případech rozhodně lepší než násilné tvoření nezajímavých a nepodstatných závěrů.
• Název spíš „Závěrečné poznámky“.

Zpráva o teoretickém výzkumu

Úvod a závěr – platí zde stále poznámky uvedené dříve. Hlavní část článku může být uspořádána způsobem, který je nejlogičtější.
Dlouhé teoretické diskuze však zpravidla vedou k tomu, že čtenář „nemůže vidět les pro samé stromy“. Měli byste tedy poblíže začátku vždy uvést celkový přehled směru vašeho myšlenkového postupu a na začátku každé kapitoly uvést, o čem bude tato kapitola jednat a jak zapadá do zmíněného postupu.
Pomocný materiál, tak jako méně významné důkazy různých odvození by měl být odložen do „Dodatků“, tak aby nerušil kontinuitu hlavního myšlenkového postupu.