By Robert W. Bly
Section 4
Improving Your Technical Writing Skills
Dear colleagues,
We are going on publishing (in Czech and Russian) main ideas of the e-book How to Write Better and Faster by Bob Bly. This e-book is extremely helpful for engineers and professionals of related areas. My own long term experience with writing technical texts obliges me to support these ideas I am pleased to have opportunity to thank the author for clearheaded expressing of them.
Again let me highly recommend you to read the e-book carefully. Here is a link to the source
|
Учитесь писать профессиональные тексты
|
Naučte se psát odborné texty
|
|
Чаще всего три обстоятельства мешают инженерам, менеджерам и другим профессионалам писать добротные технические тексты. Это:
Хотите ли преодолеть эти обстоятельства, сделайте тест TAP прежде, чем начнете писать. Тест заключается в следующем:
|
Nejčastěji tři skutečnosti nedovolují inženýrům, manažerům a ostatním profesionálům psát hezké texty s technickým obsahem. Jsou to:
Chcete-li tyto překážky překonat, udělejte test TAP dřív než začnete cokoliv psát. Test obsahuje |
|
ШАГ 1 – Спросите себя: “Разбираюсь ли я на самом деле в теме, на которую собираюсь писать, понимаю ли я своих будущих читателей, и ясно ли мне полностью с какой целью пишу”. Ошибка многих инженеров заключается в том, что они начинают писать как бы издалека, например название статьи “Управление проектом” слишком обще для технического документа. Гораздо лучше, например, название “Управление проектом ограничения расходов”. Далее вы должны совершенно отчетливо понимать, для кого пишете – для ИТР или коммерсантов или пользователей? Определив категорию читателей, вы будете знать, как соотнести вводную информацию с глубиной технического содержания. Также важно четко знать, зачем пишете. Кажется это и так ясно – просто готовите техническую информацию. А с какой целью: хотите продать свой продукт, изменить методы работы, открыть закономерности в имеющихся фактах? В этом и заключается тест TAP.
|
KROK 1 – Zeptejte se sám sebe “Skutečně rozumím tématu, svým čtenářům a mám zcela ujasněné cíle?”. Chybou mnoha inženýrů je, že začínají psát hodně obecně, např. “Řízení projektu” je příliš všeobecný název pro technický dokument. Podstatně vhodnější je například název “Řízení projektu omezení výdajů”. Dále, musíte si zcela ujasnit, pro koho pišеte – pro technický personál nebo pro obchodníky nebo pro uživatelé? Jakmile přesněji definujete, komu je především určen článek nebo dokument, budete vědět, jaký základ a jaký druh informací má budoucí stať obsahovat. Stejně tak je důležité si uvědomit, za jakým cílem dokument píšete. Zdánlivě je to jasné – přece chcete poskytnout technickou informaci. Avšak za jakým účelem: chcete prodat svůj produkt, změnit metodu práce a nebo vyhledat skryté zákonitosti v prosté posloupnosti faktů. A toto je test TAP.
|
|
ШАГ 2 – Изучите информацию по теме, на которую готовитесь писать. Многие инженеры этого не делают, думая, что и так все ясно. Раз они эксперты по данной проблематике, им не нужна дальнейшая информация. Полагаются на свой опыт и know-how. В этом-то и ошибка. Сбор информации всегда помогает повысить качество и глубину вашего произведения.
|
KROK 2 – Sbírejte informace o problému, o kterém chcete psát. Mnozí inženýři to nedělají. Domnívají se, že když už jsou experti na danou problematiku, nepotřebují další informace. Spoléhají na svoje zkušenosti a know-how. A to je chyba. Sběr informací vždy přispěje ke zkvalitnění a prohloubení materiálu, který zrovna píšete.
|
|
ШАГ 3 – После того, как вы собрали достаточное количество информации, используйте любой способ ее упорядочения, например, с помощью word procesorа и снабдите своими замечаниями отдельные источники информации.
|
KROK 3 – Po tom, co jste shromáždili dostatek informací, použijte jakýkoliv způsob jejich uspořádání, například pomoci word processoru a udělejte poznámky k jednotlivým zdrojům informací. |
|
ШАГ 4 – Составьте план документа. Его нет необходимости делать, если собираетесь писать короткий материал (письмо или краткое сообщение). Однако в случае объемного материала это совершенно необходимо. Очень часто собранный материал подскажет вам, какой способ упорядочения подходит для вашего случая (например, по алфафиту).
|
KROK 4 – Napište osnovu. Není to zapotřebí dělat, pokud píšete krátký materiál (dopis nebo interní sdělení). Ale je to k nezaplacení u rozsáhlých materiálů. Velmi často nasbíraná fakta nebo informace vám napoví, jaký způsob uspořádání je pro daný případ nejvhodnější (např. uspořádání podle abecedy).
|
|
ШАГ 5 – Теперь садитесь и пишите. При этом помните, что залогом успешного писания является писание само. С первого раза ничего никогда не получается. Некоторые переписывают текст и 9 раз. Может быть вам не потребуется переписывать столько раз, но хотя бы один раз переписать придется. Воспользуйтесь простой процедурой под названием SPP – Spit (извергать), Prune (урезать, удалять), и Polish (полировать). Когда начинаете писать, пишите все, что прийдет в голову (Spit). Всегда можете вернуться и исправить написанное.
|
KROK 5 – Sedněte si a pište. Přitom pamatujte si, že základem úspěšného psaní je psaní samo. Napoprvé to nikdy nevyjde. Někteří přepisují text i devětkrát. Možná nepotřebujete přepisovat tolik krát, ale v každém případě to musíte přepsat víc než jednou. Použijte jednoduchou proceduru, které říkám SPP – Spit (vychrlit), Prune (ořezat), and Polish (vyleštit). Když začnete psát, jen pište všechno, co vás napadne (Spit). Vždy se můžete vrátit zpátky a opravit co je zapotřebí.
|
|
ШАГ 6 – В ходе этого шага (Prune), безжалостно вычеркивайте все, без чего можно обойтись. Потом снова перепишите и выбросьте все лишнее. Поступайте так, пока не будете довольны результатом. На последнем шагу (Polish) проверьте все уравнения, единицы измерений, ссылки, орфографию и синтаксис. Снова вычерните все, что вам не нравится, красным “карандашом“ и снова все перепишите. Очень полезно разделить всю рукопись на несколько кратких секций. Каждую секцию посвятите одной мысли.
|
KROK 6 – Během dalšího kroku (Prune) přepište váš první rukopis a pořadně jej proškrtejte, vyhoďte všechno, co tam nemusí být. Pak to znovu celé přepište a opakujte tuto proceduru tak dlouho, až s výsledkem budete spokojeny. V posledním kroku (Polish) zkontrolujte všechny rovníce, jednotky měření, odkazy, pravopis a syntax. Znovu opravte všechno co se vám nezdá červenou „tužkou“ a přepište všechno znovu. Je velmi užitečné rozdělit veškeré psaní na několik kratších podkapitol nebo sekcí. Věnujte se v každé sekci jedné myšlence.
|
|
Начинайте писать с тех секций, содержание которых легко изложить. Абстракты, вводные главы, резюме и т.п. пишите на конец. Избегайте лингвистических справочников, пособий о том, как надо писать. Профессиональные писатели об этом тоже не заботятся. „Выспитесь“ на написанном. Отложите рукопись и вернитесь к ней через какое-то время. После отдыха правка пойдет намного лучше. |
Pište jako první jednodušší sekce. Abstrakty, úvodní sekce, resumé apod. pište jako poslední. Vyhněte se mluvnickým příručkám, různým pomůckám na písemný projev apod.. Profesionální spisovatelé se o to nestarají. „Vyspěte“ se na tom, co jste napsali. Odložte rukopis pryč, a vraťte k němu příští ráno nebo o několik dní poději. Po odpočinutí všechny úpravy a opravy uděláte o hodně snadněji.
|
|
Эти рекомендации также помогут вам преодолеть страх перед необходимостью писать и вы легче со всем справитесь. Помните, что успех писания – как любой формы коммуникации – это в конечном итоге дело привычки: пока вы не считаете, что писать важно и не заботитесь о форме написанного, не дождетесь успеха. Однако если будете верить, что писать – это важно и нужно совершенствоваться в этом деле, все у вас получится.
|
Tato doporučení vám pomohou překonat pocit strachu nebo obav z psaní, a také usnadní zvládnutí celého problému. Pamatujte si, že úspěch psaní – jako každé jiné formy komunikace – je do značné míry věcí zvyku: pokud si nemyslíte, že psaní je důležité a nestaráte se o jeho vylepšení, nebudete mít úspěch. Avšak pokud věříte, že psaní je důležité a je třeba jej vylepšit, dokončíte to uspěšně.
|
Nice minutes with the e-book
technical texts in english
+'){kind=small}
');
