Tato práce podléhá licenci na základě mezinárodní licence Creative Commons Attribution-ShareAlike 4.0.
Abstraktní:
Úvod do technického dokumentu by měl být výzvou pro čtenáře, aby investovali svůj čas do jeho čtení. Tato pozvánka má obvykle tři části (1) recenzi, (2) nárok a (3) program. V tvrzení by měl autor uvést, proč je agenda příspěvku užitečným rozšířením jeho historického přehledu. V nároku by měla být použita osobní zájmena a kdekoli jinde autor vyjadřuje úsudek, názor nebo volbu.
ÚVOD
V průběhu let jsem se účastnil čtení komisí více než stovky doktorských disertačních prací. Zprávy o Stanford Exploration Project (SEP) navíc obsahují asi šedesát článků ročně; a jmenovitě mám na starosti jejich prezentaci. Při celé této činnosti jsem viděl mnoho špatných abstraktů; a v každém případě jsem ušetřil sebe i autora velkým problémem s odkazem na krátký článek Scrutiny of the abstract od Landese [1966], který byl zpřístupněn aspirujícím autorům SEG. Zřídka už přepisuji abstrakty autorů — obvykle stačí, aby si přečetli Landesův papír a přepsali ho sami. Landesův vlastní abstrakt stojí za zmínku:
Abstrakt je nanejvýš důležitý, protože ho čte 10 až 500krát více lidí, než slyší nebo čte celý článek. Neměl by to být pouhý recitál probraných témat. Výrazy jako „je diskutováno“ a „je popsáno“ by nikdy neměly být zahrnuty! Abstrakt by měl být kondenzací a koncentrací základních informací v příspěvku.
Ani úvody nejsou snadné. S potěšením oznamuji, že jsem v posledních letech vytvořil vzorec pro zavedení. S tímto příspěvkem, který vysvětluje můj vzorec, doufám, že snížím potřebu individuálního doučování. Možná budete schopni vytvořit dobrý úvod, aniž byste se řídili mým vzorcem, ale pokud máte potíže s vytvořením úvodu, který by potěšil ostatní lidi a chtěli byste dokončit psaní a pokračovat ve svém životě, doporučuji vám postupovat podle mého vzorce.
Nejprve popíšu tři základní části úvodu a poté vám dám několik tipů na celkovou organizaci. Uvidíte, proč jsou úvody tak obtížné psát, jakmile pochopíte, jak úvody závisí na tom nejtrapnějším ze všech slov „já“.
TĚLO ÚVODU
Můj vzorec pro úvod je sekvence tří částí. Jedná se o (1) přezkum, (2) nárok a (3) pořad jednání.
Přehled
Vyberte si asi 3–10 příspěvků poskytujících zázemí pro váš výzkum a ke každému z nich něco řekněte. Z každého abstraktu byste mohli parafrázovat větu nebo dvě. Recenze nemá být historickou revizí, která se vrací k Newtonovi nebo Descartovi. Pokuste se najít několik příspěvků od vašich kolegů z kanceláře, vašeho poradce, vašich předchůdců nebo jiných spolupracovníků. Tímto způsobem můžete najít někoho, kdo vám pomůže kritiku!
Kdokoli může postupovat podle těchto pokynů a napsat recenzi, která vypadá reprezentativně. Kde je zapotřebí inteligence a dovedností, je organizace kontroly tak, aby vedla k něčemu, konkrétně k vašemu nároku.
Tvrzení
Nejdůležitější část úvodu je pohřbena uprostřed. To je tvrzení. Nárok je místo, kde tvrdíte, že vaše práce je užitečným rozšířením recenze, kterou jste právě napsali. Pokud někdo říká, že váš text je „nemotivovaný“, neuráží tím vaši lidskost; znamená to jen, že nemohou najít váš nárok.
Ve své žádosti byste měli použít osobní zájmeno „já“ (nebo „my“, pokud nejste jediným autorem). Slovo „já“ říká lidem, kde dojdou obecné znalosti a začnou vaše nápady. Pokud píšete disertační práci nebo článek do recenzovaného časopisu, měli byste novým způsobem přispět ke stávajícím znalostem. Váš příspěvek není přijatelný bez identifikovatelného nároku.
Plány
Program je uveden na konci mnoha úvodů. Shrnuje, co čtenáři ukážete, jak váš příspěvek postupuje. Vaše agenda bude nudná, pokud se bude jednat pouze o recitál témat, kterým se budete věnovat. Vaše agenda by měla sdělit, jak váš příspěvek funguje, aby splnil váš nárok. Tímto způsobem by měla vaše agenda vyjasnit váš nárok.
Pořad jednání není tak důležitý jako přezkum a tvrzení. Snažte se to zkrátit.
Občas budete mít to štěstí, že budete psát o něčem, z čeho lze vyvodit některé vaše závěry v jednoduchých prohlášeních. Pokud ano, uveďte je brzy, hned po vaší agendě. Nesnažíte se napsat záhadu! Váš příspěvek začne číst mnohem více lidí, než jej dočtou. Motivujte je, aby skončili! Mnoho technických dokumentů se bohužel nehodí k časným závěrům.
PO ÚVODU
Samozřejmě chcete, aby lidé četli i mimo váš úvod. Dobře si tedy rozmyslete, jaké jsou pořadí vašich materiálů a jak říkáte věci. (Všimněte si, že tento malý odstavec je malým abstraktem toho, co následuje).
Osobní zájmena můžete použít i jinde ve své práci. Obecně byste měli používat osobní zájmeno, kdykoli vyjadřujete názor nebo uplatňujete úsudek. Jindy se používá „I“, kdykoli existuje jednoduchá volba. Například „Pro otestování teorie jsem vybral některá data“ nebo „Prozkoumání teorie naprogramoval jsem rovnice“ nebo „Pro vyhodnocení teorie jsem vytvořil několik syntetických seismogramů.“
Ať už jsou vaše myšlenky pevné jako skalní kámen nebo spekulativní jako mraky, potřebujete zájmena první osoby. Pokud jsou vaše myšlenky spekulativní, zájmena signalizují odmítnutí odpovědnosti. Pokud jsou vaše myšlenky pevné, zájmena signalizují, že vám mohou být připsány. Když vaši přátelé uvidí vaše osobní zájmena, budou vědět, kde by měli nabídnout své dotazy a návrhy.
Dobré vědecké práce obsahují rozsáhlé výroky od starověkých axiomů a obecných znalostí až po spekulace a přímé odhady. Je vinou pisatele, pokud náhodný čtenář nedokáže rozlišit tyto typy výroků. Osobní zájmena jsou dobrá slova, která pomáhají udržovat jasné rozlišení. Další dobrá slova pro tento účel jsou „měl, mohl, mohl, mohl, může, může, je, dělá, …“. Využijte je všechny a vyberte pro každý účel to nejlepší.
Někteří redaktoři vědeckých prací mechanicky zavádějí osobní zájmeno „I“, aby se vyhnuli pasivnímu hlasu. Nesouhlasím s nimi. Například tito redaktoři změní vaše slova „Nahrazení rovnice (1) do rovnice (2) dá …“ na slova „Nahrazení rovnice (1) do rovnice (2) najdu …“. První formulace uvádí jednoduchou skutečnost, ale druhá formulace naznačuje, že někdo jiný by mohl získat jiný výsledek.
Pořadí materiálu
Moje práce často popisují procesy. Považuji za nejlepší nejprve popsat vstupy, dále popisuji výstupy a nakonec popisuji samotný proces. Je nelogické popisovat výstup před procesem, který jej vytváří, ale tento nelogický přístup pomáhá lidem vidět, kam jdu a proč dělám to, co dělám.
Můžete napsat svůj příspěvek tak, aby každá část navazovala na dřívější části. Stejně jako axiomatický přístup k geometrii byste mohli odmítnout odkazovat na dosud neprokázané věci. Ale spíše než psát svůj příspěvek tímto způsobem, je rozumnější maximalizovat počet čtenářů. Váš příspěvek začne více lidí, než dosáhne konce. Pokuste se uvést výsledky, než je prokážete. Zatlačte komplikované derivace a odbočky až do konce. Složité matematické derivace, zejména pokud jsou okrajové pro vaši hlavní práci, by měly být odsunuty do příloh.
Ošuntělé konstrukce okrádají prózu o sílu. -Allen Matusow.
Co je centrální a co periferní?
Ve svém příspěvku možná budete chtít zahrnout odbočení, možné aplikace atd. To je hezké. Nezapomeňte však zahrnout jazyk, který je označuje jako periferní. Pokud tak neučiníte, některým lidem bude chybět váš hlavní bod a budou se hádat s těmito periferními záležitostmi.
Psaní angličtiny jako druhého jazyka
Co je předmluva?
Technický dokument má zřídka předmluvu, protože předmluva popisuje samotný dokument, aniž by popisoval obsah materiálu. Například pokud bych přednesl předmluvu k tomuto článku, řekl bych, že tento článek se dříve objevil ve zprávě Stanfordského průzkumného projektu.
Úvod do projevu
Úvod do řeči je zcela odlišný od úvodu technického listu.
| Papír | Přednáška |
|---|---|
| Posouzení | Pozorovatel |
| Nárok | Teze |
| Denní program | Náhled |
ZÁVĚR
Tento krátký článek není typickým technickým dokumentem, ale možná byste se rádi ohlédli za mým úvodem a zjistili, zda se řídím svými vlastními radami.
ODKAZ
- Landes, Kenneth K., 1966, Scrutiny of the abstract, II, Bulletin of the American Association of Petroleum Geologists, 50, p.1992 [k dispozici také zde]