Всё для технического документирования
+7 (495) 001-00-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Качество писательства никогда не сможет быть лучше качества исследования

21.10.2016

00Допустим, написанный автором материал оказался невысокого качества. Как определить, в чём причина: материал плохо написан или всё же автор не до конца разобрался с предметом?


От редактора: Следующая статья написана Германом Хольтцем (Herman Holtz) является частью «классической» коллекции статей, которые прошли проверку времени, независимо от того, сколько появилось и ещё появится новых технологий.

Большинство из нас, вероятно, имеет некоторые представления о том, что такое хорошее, а что такое плохое писательство, и вероятно, большинство из нас измеряют или судят писательство посредством различных стандартов, которые, как нам кажется подходят для измерения качества. Однако правда заключается в том, что качество — характеристика эфемерная и отличается для каждого вида писательства. Допустим, я прочитал книгу, которую кто-то считает отличной прозой, но она оказывалось довольно унылой. Но причина этого может быть в том, что мне не нравится жанр — некоторая часть научной фантастики мне не нравилась, например, вообще — и я не мог высказывать мысли о том, каким должно быть хорошее писательство в этом жанре, потому что я в принципе не мог понять, почему у меня возникают такие ощущения. С другой стороны, моя собственная работа (и собственные успехи) касались в основном выработки рекомендаций о том, как писать, и поэтому я оттачивал мнение о качестве писательства в виде советов по каждому вопросу.

Исследование против качества писательства

С годами, особенно работая в качестве редактора и, позже, в качестве руководителя, я часто наблюдал определённый феномен, проявлявшийся в черновиках рукописей. Рукопись начинается хорошо и течёт свободно, текст понятный, но затем внезапно появляется много «воды» и текст в целом становится неясным. Это означает в таких случаях, что писатель хорошо обращается с основной информацией по предмету, но сталкивается с проблемами, когда дело начинает касаться деталей. На первый взгляд это может казаться плохим писательством, но им не является, потому что это плохое исследование. Оно отражает далёкое от адекватного понимание предмета: писатель не разобрался в предмете перед тем, как пытается объяснить его читателю.

Диагноз и его тестирование

Как ни странно, возможно, у вас будут проблемы с тем, чтобы писатель поверил вашей оценке проблемы. Для писателя характерно не соглашаться с тем, что он не знает предмет достаточно хорошо, и он будет убеждать, что знает его детально.

Я тестировал свой диагноз и решал проблему, требуя от автора оставить рукопись мне, вернуться к исследованию на день или два, а затем написать всё с нуля. Результатом обычно являлось существенное улучшение качества рукописи. Этот тест не только успешно разрешал проблему, но был также замечательным предметным уроком для писателя, который никогда не забывает выученный урок.

Как писатель, вы должны научиться измерять адекватность собственного исследования того, как и что необходимо делать. Не всегда легко определить, когда вы достаточно разобрались в предмете, чтобы писать о нём со знанием дела и авторитетно. Я тестирую себя, самостоятельно редактируя свою работу каждое утро в качестве первой задачи рабочего дня. Если то, что я пишу, требует две недели моего времени до завершения, я редактирую ранние части рукописи множество раз до того, как работа будет завершена. Это даёт множество шансов по нахождению неясностей, по которым я должен выяснить определённые детали.

Да, у каждого из нас есть склонность считать себя недалёким, верить, что то, что мы знаем, на самом деле, не соответствует истине; однако есть возможность натренироваться, чтобы проверять собственное писательство достаточно объективно. Проявите подозрительность в тот момент, когда технический уровень вашей рукописи начинает падать. Вернитесь к исследованию и посмотрите, что упущено в ваших познаниях относительно предмета.

Хорошее писательство — результат отличного исследования

Любое писательство требует исследования, а описание решения проблем требует основательного и детального исследования. Горькая правда в том, что качество вашего написания такого материала никогда не сможет быть лучше, чем качество исследования, которое вы провели в отношении предмета. Требуется серьёзное исследование для написания серьёзной инструкции по решению проблем; все писательские способности в мире не могут компенсировать необходимую информацию. Но вы должны учиться измерять адекватность вашего исследования с помощью измерения адекватности ваших знаний. Думайте об исследовании в терминах качества, как вы думаете о писательстве. Так и есть, исследование может быть плохим, посредственным или серьёзным, и хороший справочный материал требует серьёзного исследования.

Источник: The Quality of the Writing Can Never Be Better Than the Quality of the Research

Тэги: , , ,

< Вернуться к списку публикаций

Облако тегов