Надо ли быть гением, чтобы написать грамотную техническую статью? Могут ли лирики правильно писать про физику? Может ли физик доступно объяснить про дифракцию и интерференцию в свете корпускулярно-волнового дуализма? В этой статье не будет ответов на эти вопросы. В тексте этой публикации приведены основные (но далеко не все!) рекомендации, которых следует придерживаться при написании технических статей.
Не существует единого общепринятого алгоритма или свода правил написания статей, но есть ряд общих правил, которых стоит придерживаться при работе над публикациями любой тематики.
В первую очередь, необходимо разбираться в предмете и чётко понимать, на какую целевую аудиторию должен быть ориентирован текст. Во-вторых, следует сформулировать тему и выразить её в краткой и ёмкой форме в заголовке. Далее – писать грамотно, в рамках выбранной темы, соблюдая стиль повествования.
Чтобы полностью раскрыть тему и не забыть о мелких нюансах, которые могут стать решающими, следует составить план публикации. Материал необходимо изложить последовательно, в логичном порядке.
Основной текст статьи следует излагать краткими предложениями. Удачно подобранные методы форматирования (списки, абзацы и т.п.) создают зрительные ориентиры, помогающие читателю быстро просматривать информацию и находить интересующие его сведения. Однако, чрезмерное использование элементов форматирования (маркированные и нумерованные списки, выделение слов) снижают качество подачи материала.
Написание технических статей требует особых умений, навыков и знаний в предметной области. Статья должна быть написана грамотным русским языком – не только с точки зрения орфографии и пунктуации, но также синтаксиса и фразеологии. Красивый технический стиль – отличный способ избежать ситуации, когда читатель начинает задумываться о том, насколько автор компетентен в рассматриваемом вопросе. Давно известна истина: если вы чётко и ясно мыслите, вы чётко и ясно излагаете.
Задачи у текстов могут быть разными: просвещение, продажа услуг или разработка экспертных материалов. При этом следует помнить, что в результате должен получиться текст на техническую тематику, а не какой-то технический документ. Не стоит избегать образного, живого языка: образы облегчают понимание и освоение информации. Однако надо помнить, что в техническом тексте материал должен быть изложен чётко, конкретно и лаконично. Следует избегать техницизмов, профессионализмов, оборотов разговорной речи.
Даже такие устоявшиеся жаргонизмы, как «юзер», «свитч» и тому подобные, неуместны в технической статье. Не стоит использовать сложные термины, особенно, если целевой аудиторией является неподготовленный читатель. Если применения таких терминов избежать не удалось, можно добавить глоссарий с доступным толкованием использованных понятий. Однако объяснять очевидное также не стоит. При ссылке на общеизвестные методы, технологии, алгоритмы не нужно разъяснять их суть, достаточно просто указать, как они применяются.
Итак, в первую очередь необходимо определиться с темой статьи. Тема – это кратко сформулированное содержание предметной области, в рамках которой будет формироваться текст. Тема определяет терминологию, степень детализации рассуждений и определений, ссылки на внешние источники информации, количество и сложность дополнительного материала в виде формул, таблиц, иллюстраций. Также необходимо определиться с целевой аудиторией, уровнем доступности информации, которая будет представлена в раскрытие темы статьи и задачей публикации. Это определит стиль изложения текста.
Далее следует составить план статьи, тезисно определить содержание каждого её раздела. В общем виде он может выглядеть так:
Вступительная часть знакомит читателя с сутью предлагаемого материала. Эта часть публикации должна быть краткой, не более двух-трёх предложений о содержании статьи и её целевой аудитории. Можно сначала написать основной текст статьи и заключение, а потом составить краткую аннотацию написанного и вынести её во введение.
Основная часть – самый большой и важный раздел статьи. В ней последовательно должна быть раскрыта тема публикации, изложены суждения, которые позволили сделать выводы, выдвинуты предложения и рекомендации. Эта часть текста должна содержать не только фактический материал, но и анализ, критическую оценку фактов. В этой части будет полезно привести схемы, таблицы, графики, формулы, рисунки, фотографии. Таблицы должны быть снабжены заголовками, а графический материал – подрисуночными подписями. На каждый такой элемент в тексте статьи должны быть даны ссылки на него.
При написании текста статей на технические темы следует придерживаться научно-технического стиля изложения и руководствоваться основными рекомендациями по оформлению текстовых документов
ГОСТ 2.105-95 (ЕСКД. Общие требования к текстовым документам). Такой стиль, скорее всего, знаком той аудитории, на которую рассчитан материал, и читателям будет проще ориентироваться в тексте и элементах оформления. Технический текст должен содержать точные формулировки и конкретные понятия. Например, определение «большой» или «маленький» не несёт в себе конкретной информации об объекте. Рекомендуется приводить или конкретные параметры (в данном случае, габаритные размеры) или определённые сравнения, например «размером со стандартный лист бумаги формата А4». Следует использовать стандартизированные единицы физической величины, их наименования и обозначения по ГОСТ 8.417-2002 (ГСИ. Единицы величин).
Не стоит использовать в тексте лишние слова («весь процесс в целом», «в целях» вместо «для») и различные загадочные термины («это явление вызвано определёнными факторами», «в некотором смысле» и т.п.). Аккуратности требует употребление возвратной формы глагола. Использовать её возможно, когда речь идёт о самопроизвольно протекающих процессах: «деталь охлаждается». Если требуется описать технологическую операцию, которой подвергают объект, следует писать «деталь охлаждают».
Заключительная часть статьи должна быть увязана с основным текстом как по смыслу, так и стилистически. В ней тезисно излагают выводы, сделанные на основании изложенного материала. Они должны быть объективными, без авторской интерпретации. Так же можно привести оценку практической значимости результатов проведенных исследований.
После того, как работа над текстом статьи закончена, следует внимательно изучить её на предмет употребления ссылок на источники информации и терминов, требующих уточнения, и оформить соответствующие разделы статьи.
Список использованных источников должен содержать название, фамилию и инициалы автора, адрес, где с его содержанием можно ознакомиться. Помещается он в конце статьи. В качестве заголовка можно использовать такие варианты: «Список литературы», «Список использованных источников», «Литература», «Библиографический список». В начале такого перечня располагают законы, указы, законодательные акты.
Далее – остальные печатные источники. В конце указываются электронные ресурсы. Все элементы списка должны располагаться в алфавитном порядке. Книгу без указания автора включают в соответствии с алфавитом по названию. Книги на иностранном языке указывают после книг на русском. В тексте статьи должны быть оформлены ссылки на список источников информации.
Варианты оформления ссылок:
Глоссарий – словарь специализированных терминов. Составлять его надо также в алфавитном порядке. Определение термина в глоссарии должно состоять из двух частей:
Когда работа над текстом статьи и его оформлением окончена, не забудьте сохранить проделанную работу. Перечитайте написанное и проведите авторское редактирование: удалите лишнее, упростите слишком сложно выраженные мысли, непонятные термины, разверните неточные определения. После этого ещё раз перечитайте своё творение, прислушайтесь к внутреннему голосу – если правка и доработка статьи больше не требуются, направляйте её заказчику. Возможно, у заказчика при ознакомлении с работой возникнет желание что-то изменить, добавить, расширить или конкретизировать. Перед тем как вносить такие правки, оцените, на сколько изменения повлияют на раскрытие темы и смысл изложенного. Не стесняйтесь спорить с заказчиком, аргументировано доказывая свою точку зрения.
Не следует рассматривать рекомендации данной статьи как догму, они призваны помочь сориентироваться и начать работу с учётом опыта и наработок других авторов. Ниже приведена примерная последовательность действий при написании технической статьи:
