Написание отчётов и статей (рекомендации) — различия между версиями

Версия 22:40, 6 июня 2011

Приведённые ниже рекомендации по подготовке статей, отчётов, квалификационных работ адресованы, главным образом, студентам и аспирантам.

Введение

Во всем мире научные статьи пишут по определенным канонам, выработанным многими поколениями учёных. Традиции в данном случае необходимы для того, чтобы разные люди без дополнительных усилий понимали друг друга. Чем жёстче требования к терминологии, языку, форме подаче материала, оформлению, тем меньше читатель отвлекается на второстепенные детали, тем быстрее он сможет понять основную суть работы. Пренебрегать этими традициями — значит быть неадекватным в глазах сообщества.

Всякая научная статья преследует одновременно две цели:

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

Типичная структура научной статьи

Аннотация

Краткое описание темы исследования и основного результата, одним абзацем на 5–15 строк, без формул, без ссылок на литературу, без узкоспециальных терминов.

Цель аннотации: обозначить в общих чертах, о чем работа. Прочитав аннотацию в течение минуты, не-специалист в данной узкой теме должен понять, интересна ли ему эта работа, и стоит ли читать дальше.

Аннотация собирается в последнюю очередь путем легкой модификации ключевых фраз (наиболее важных и удачно сформулированных) из введения и заключения.

Введение

Во введении рассказывается, где возникает данная задача, и почему ее решение так важно. Вводится на неформальном уровне минимум терминов, необходимый для понимания постановки задачи. Приводится краткий анализ источников информации (литературный обзор): как эту задачу решали до сих пор, в чем недостаток этих решений, и что нового предлагает автор. Формулируются цели исследования. В некоторых случаях, в конце введения даётся краткое содержание работы по разделам; при этом отмечается, какие подходы, методы, алгоритмы предлагаются автором впервые. При упоминании ключевых разделов кратко формулируются основные результаты и наиболее важные выводы.

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

Введение лучше писать напоследок, так как в ходе работы обычно происходит переосмысление постановки задачи. Если же введение писать, когда работа еще не готова, задача усложняется вдвойне. В конце обычно приходит понимание, что всё получилось совсем не так, как планировалось в начале, и исходный вариант введения всё равно придётся переписывать. Кстати, к таким «потерям» надо относиться спокойно — в хорошей работе почти каждый абзац многократно переделывается до неузнаваемости.

Определения и обозначения

Формальная постановка задачи. Для известных понятий желательно придерживаться стандартных обозначений. Общепринятые термины вводятся словом «называется». Термины, придуманные самим автором, вводятся словами «назовём» или «будем называть». Обычно этот раздел заканчивается формальной постановкой задачи.

Именно с этого раздела стоит начинать писать статью.

Известные результаты

Перечисляются подходы, методы, факты, на которые существенно опирается данная работа, но которые могут быть не известны широкому кругу читателей. Здесь ссылки на литературу обязательны. Теоремы только формулируются, но не доказываются.

Цели данного раздела. Во-первых, сделать статью самодостаточной — дать необходимый минимум информации тем читателям, которые не очень хорошо ориентируются в теме, но желают поближе познакомиться именно с данной работой. Во-вторых, облегчить сопоставление полученных автором результатов с ранее известными.

Новые подходы и результаты

Один или несколько разделов — основные результаты, полученные автором. Собственно, ради их опубликования и пишется весь текст. Теоремы приводятся с доказательствами.

Вычислительный эксперимент

Описывается прикладная задача, параметры анализируемых данных (например, сколько объектов, сколько признаков, и каких они типов), параметры эксперимента (например, как производился скользящий контроль). Результаты экспериментов представляются в виде таблиц и графиков. Объясняется точный смысл всех обозначений на графиках, строк и столбцов в таблицах. Приводятся выводы: в какой степени результаты экспериментов согласуются с теорией? Достигнут ли желаемый результат? Обнаружены ли какие-либо факты, не нашедшие объяснения, и которые нельзя списать на «грязный» эксперимент?

Цель данного раздела: продемонстрировать, что предложенная теория работает на практике; показать границы её применимости; рассказать о новых экспериментальных фактах. Чисто теоретические работы могут не содержать данного раздела (не работает, ну и не надо — зато теория красивая). Кстати, теоретики имеют право не догадываться, где, кому и когда их теории пригодятся.

Обсуждения и выводы

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

Заключение или основные результаты

В квалификационных работах последний раздел нужен для того, чтобы конспективно перечислить основные результаты, полученные лично автором. Результатами, в частности, являются:

• Предложен новый подход к…
• Разработан новый метод…, позволяющий…
• Доказан ряд теорем, подтверждающих (опровергающих), что…
• Экспериментально показано, что…

Цель данного раздела: доказать квалификацию автора. Даже беглого взгляда на заключение должно быть достаточно, чтобы стало ясно: автору удалось решить актуальную, трудную, ранее не решённую задачу, предложенные автором решения обоснованы и проверены.

Кстати, в отзывах и рецензиях это выражается примерно такими словами: «работа удовлетворяет всем требованиям, предъявляемым к [бакалаврским, магистерским, дипломным, кандидатским — ненужное вычеркнуть] диссертациям; автор достоин присуждения ему звания [бакалавра, магистра, и т.д.]».

Благодарности

Ссылки на гранты; реже — благодарности коллегам, подсказавшим важные идеи.

Литература

Дурным тоном считается:

• ссылаться на работы только одного-двух авторов (например, себя или шефа);
• ссылаться на слишком малое число работ;
• ссылаться только на очень старые работы;
• ссылаться на работы, которых автор ни разу не видел;
• вообще ни на что не ссылаться.

Десять принципов ясного изложения

Чтобы научиться самому хорошо писать научные тексты, надо постоянно читать чужие научные тексты. При этом задумываться над такими вопросами: Всё ли мне действительно понятно? Если что-то не понятно, то почему — моих знаний не хватает или написано плохо? Если написано плохо, то что именно, и что должен был бы сделать автор, чтобы я его понял. При таком вдумчивом чтении Вы скоро выработаете свои приёмы ясного изложения.

Прямой путь — самый короткий

Всегда используйте минимальный набор средств (понятий, обозначений, пояснений), достаточный, чтобы Вас поняли. Не правда ли, красивые общие слова, но совершенно неконкретные... Как же воспользоваться этой рекомендацией на практике? Одна из возможных технологий такая:

Подумайте, какую основную мысль Вы собираетесь донести до читателя. Не начинайте издалека, именно её сразу и напишите. Теперь подумайте, почему Вас могут не понять, если сходу прямо так и сказать. Ваш коллега, вместе с которым Вы делали эту работу, наверное, поймёт. А вот незнакомому читателю надо сперва объяснить все использованные Вами понятия, сформулировать проблему, объяснить, зачем её надо решать, и т.д. Всё это придётся написать перед основной мыслью.

Главное — не «ходить вокруг да около» и не писать лишнего! Пишите только то, без чего основную мысль объяснить невозможно.

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

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

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

Чаще перечитывайте текст и проверяйте каждую фразу: можно ли её выкинуть? Является ди такой ход изложения кратчайшим? Тут полезно быть жадным, но только в том смысле, чтобы побольше выкинуть, а не увеличить объём текста.

Время читателя — ценнейший ресурс

Эталоном неясного изложения будем считать «казённый язык» — сухой, скучный, трудно понимаемый, но при этом формально абсолютно корректный (бесспорно, существуют образцы ещё более ужасного изложения; однако здесь обсуждается проблема, как из хорошего сделать лучшее).

Наблюдение. «Казённым» стилем обычно пишутся законы, руководства и инструкции. В советские времена в таком стиле писали газеты (хочешь понять — читай между строк). Таким стилем все ещё пишут некоторые ученые… Но это неправильно.

Автор должен стремиться экономить время читателей хотя бы потому, что он один, а читателей много. Сегодня никто не хочет тратить своё время на чтение между строк. Время дороже денег. Если статью не удаётся понять быстро, она будет отложена навсегда.

Краткость — сестра таланта

Фразы должны быть короткими. В каждой фразе должна быть ровно одна мысль. В русской фразе (кстати, как и в английской) самое важное слово, значимость которого хочется подчеркнуть особо, ставится последним. Обратите внимание на положение слов «особо» и «последним» в предыдущей фразе. Теперь ясно, что имеется в виду?

Наблюдение: в «казенных» текстах фразы длинные, содержат по несколько мыслей, и наиболее значимое слово прячется в середине.

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

Наблюдение: в гуманитарных текстах (например, в Библии) делается наоборот — одна и та же мысль повторяется многократно, но в разных формах. Чтобы каждый смог осознать её в той форме, которая лично ему ближе.

В техническом тексте нет необходимости украшать содержание разнообразием форм, так как его цель — передача знания, а не ощущения.

Комментирование формул

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

Наблюдение. Математики делятся на две категории. «Алгебраисты» быстро понимают и хорошо запоминают формулы. «Геометры» предпочитают понимать содержательный смысл высказываний. Алгебраисты более формальны, геометры — более интуитивны. Первые быстрее воспринимают язык формул, вторые предпочитают воспринимать идеи, вникая в технические подробности только в случае необходимости.

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

Простота и постоянство обозначений

Система обозначений должна быть проста (не перегружена) и не меняться по ходу изложения.

Наблюдение. Трудно читать статью, в которой постоянно повторяются одни и те же сложные (состоящие из многих символов) агрегаты. Почему? Читатель тратит время и мыслительные усилия на постоянное сравнение того агрегата, который он видит сейчас, с теми, которые встречались на предыдущих старницах. Кстати, писать (скорее, генерировать) такие статьи гораздо легче, чем читать.

Отсюда вывод: если агрегат встречается более двух раз, возможно, для него стоит ввести вспомогательную букву и как-то назвать его словами. Человеку привычнее и приятнее запоминать и сравнивать имена, чем иероглифы, состоящие из формул.

Наблюдение. Всегда можно найти способ избежать тройных индексов, например, ввести вспомогательное подмножество.

В английском алфавите достаточно букв, чтобы приписать им фиксированные роли. Например, если договорились, что <tex>x_i</tex> — это <tex>i</tex>-й объект, то лучше не использовать букву <tex>x</tex> и индекс <tex>i</tex> для чего-либо, кроме объектов. Тогда читатель быстро привыкает к обозначениям основных понятий, и уже не будет отвлекаться на то, чтобы вернуться выше и разобраться, в данном случае <tex>i</tex> глобален (тот самый, что был использован при введении обозначений в самом начале), или он снова в десятый раз поменял смысл.

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

Баланс формального и неформального

Формальное изложение (гипотезы, определения, леммы, теоремы, следствия, замечания) должно перемежаться неформальными пояснениями, интерпретациями, замечаниями, примерами, апеллирующими к интуиции и здравому смыслу. Однако оформляться это должно так, чтобы читатель сразу понял: «вот тут закончились доказательства и начались интерпретации». В англоязычных статьях в этом месте принято вставлять раздел Discussion (обсуждение).

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

Золотая середина — это дозированное сочетание математически строгого изложения и неформальных пояснений, которые подкрепляют друг друга.

Основные идеи текста должны быть в целом понятны, если целиком пропускать доказательства. Если внутри доказательства спрятана важная идея, то её обсуждение стоит вынести за пределы доказательства. В таком случае лучше разбить доказательство на леммы.

Структуризация

Изложение основной части должно быть структурировано, то есть разбито на блоки (параграфы, разделы). Каждый блок должен решать более-менее обособленную задачу. В начале блока должно быть объявлено, зачем она решается, и почему она решается именно так. Чтобы ответить на вопрос «зачем», надо вспомнить общую цель всего исследования. Чтобы ответить на вопрос «почему так», надо сделать обзор литературы.

Наблюдение. В маргинальных исследованиях вопросы «зачем» и «почему так» либо не ставятся, либо на них даются невнятные (неконкретные, слишком философские) ответы. Это означает, что автор не потрудился продумать самые трудные вопросы и возложил эту работу на читателя.

Каждый раздел, независимо от уровня и объема, строится по одному и тому же сценарию. В начале неформально объясняется постановка задачи и её роль во всем исследовании (или в объемлющем разделе). В заключении неформально объясняется, что получилось, и как это интерпретировать. Если в следующих разделах полученный результат будет улучшен, об этом стоит упомянуть. Средняя часть может быть целиком формальной.

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

Логичная последовательность изложения

Каждая следующая фраза должна логично вытекать непосредственно из предыдущей (или нескольких предыдущих). Слишком жёстко? Тогда хотя бы 95% фраз. Следить за линейной логикой изложения на порядок менее утомительно, чем за перескоками с темы на тему. Резкая смена темы должна оформляться в явном виде как новый параграф, раздел, подраздел.

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

Наблюдение. В учебниках и хороших книгах таких грубых ошибок не бывает — благодаря тому, что эти тексты десятки раз вычитываются авторами, рецензентами и редакторами.

Точность передачи смысла

Это, наверное, самое сложное. От автора требуется хорошее владение как техническим, так и литературным языком.

Наблюдение: хорошо садиться писать статью, начитавшись хорошей специальной или художественной литературы.

От автора также требуется изрядная изобретательность. Автор имеет полную свободу выбора — какие понятия и определения ввести, чтобы дальнейшее изложение было максимально удобным и понятным.

Наблюдение: презентабельность основного результата может сильно зависеть от того, какими словами о нём рассказывают. Если суть результата не удаётся донести парой фраз, это, возможно, признак того, что стоило бы ввести несколько новых понятий. То есть придать нескольким хорошо известным русским словам новый, Ваш собственный, узко специальный, смысл. Разумеется, удачный выбор таких слов — это искусство.

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

Наблюдение: в предложениях за точность смысла отвечают глаголы. Тщательный подбор одного единственного глагола иногда способен заменить пару строк простанных комментариев.

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

Наблюдение: «казенные» тексты напичканы абстрактными глаголами.

Семь раз прочти, один раз отправь

На самом деле семь раз — это мало. Обычно студент, пишущий свою первую курсовую или статью, не отдаёт себе отчёта в том, сколько ляпов будет сделано по невнимательности. Почти в каждой фразе! Это нормально, людям свойственно ошибаться. Ещё многим людям свойственно не замечать собственных ошибок. Поэтому стадию внимательного вычитывания ни в коем случае пропускать нельзя.

Рекомендация: в конце работы над статьёй запланируйте посвятить целый день многократному внимательному прочтению своего труда. Где-то будут пропущены формулы или целые фразы. Это не пустяк! Поставьте себя на место незнакомого читателя и осознайте факт: научный текст легко может оказаться целиком непонятным из-за одной единственной ошибки. Где-то можно перестроить фразу и сказать получше. Или покороче. Где-то можно упростить обозначения или вообще избавиться от лишних закорючек. Иногда чисто формальное упрощение неожиданно подсказывает идею более изящного доказательства. К вечеру Ваш текст начнёт Вам нравиться, и Вы поймёте, что день прожит не зря. Не лишайте себя этого кайфа!

Перфонтана

Опыт преподавания и научного руководства показывает, что среди студентов находятся любые крайности. Есть студенты с врождённым чувством качества русского текста, которые в первый же раз приносят вполне «гладко написанную» работу. Другая крайность — когда в тексте нет логических связок между предложениями, количество неточностей и опечаток огромно, всё что можно было перепутать, перепутано, и буквально всё надо переделывать. Возможно, человек просто торопился и ни разу не прочитал то, что написал. Но иногда оказывается, что внутренние критерии качества написанного текста у человека просто отсутствуют. Это не фатум — дело наживное. Но и психологическая встряска в таком случае не повредит ;) Потратьте 15 минут времени и посмотрите на Перфонтану — как китайские производители детских кубиков, плохо владеющие русским языком, напутали всё, что можно было напутать. Получилось до слёз смешно. Обычно в этот момент студент осознаёт, какие чувства у преподавателя вызывает его работа... и начинает стараться.

Дело техники

Для оформления научных статей, отчётов, квалификационных работ, учебных курсов, книг рекомендуется освоить систему компьютерной вёрстки LaTeX.

• Памятка по установке и использованию MiKTeX и WinEdt.
• LaTeX в примерах (pdf) — сборник примеров, помогающий довольно быстро освоить LaTeX в объеме, достаточном для написания первой статьи.

Статья на английском

Это отдельная большая тема для разговора, а краткие рекомендации такие.

• Перед написанием собственного текста обязательно прочтите несколько канонических обзоров по Вашей теме, чтобы «пропитаться» правильными терминами, мотивациями, оборотами речи, конструкциями английских фраз — они не такие, как в русском языке!
• Обязательно прочтите книги Сосинского или Кутателадзе (а лучше обе), даже если Вы считаете, что хорошо знаете язык. Первая даёт простую методику, которая позволит сразу приступить к делу; вторая книга глубже и потребует более тщательного изучения. Если совсем кратко, основные рекомендации таковы:
  • не переводите текст с русского на английский, а рассказывайте содержание вашей работы по-английски;
  • в каждой фразе придерживайтесь жёсткого порядка: подлежащее → сказуемое → дополнение;
  • не стройте слишком сложных и длинных предложений;
  • используйте математические клише, которые даются в этих двух книгах;
• Введение, обзор и другие разделы, где больше всего «человеческой речи», пишите в последнюю очередь. Начинать проще всего с раздела определений и обозначений, затем переходить к формальным математическим результатам, затем к разделу экспериментов. Тогда к моменту написания вводных и заключительных разделов само собой сложится понимание того, как рассказать о том же самом менее формально.
• Если какое-то словосочетание вызывает сомнения, поищите его в Google вместе с возможными вариантами. Часто ли оно употребляется в научных текстах, особенно по Вашей тематике? Не является ли оно термином в совсем другой области? Не совпадает ли оно с чем-нибудь неподходящим или даже неприличным? Поиск подходящих отрывков фраз в Интернете — это долгий, но верный способ написать хороший текст даже при посредственном владении языком. Как обычно, приходится искать компромисс между временем и качеством.

См. также

• Научно-исследовательская работа студентов и аспирантов (рекомендации)
• Подготовка презентаций (рекомендации)
• Защита выпускной квалификационной работы (рекомендации)

Литература

• Pat Langley. Crafting Papers on Machine Learning. ICML 2001.
• А. Б. Сосинский. Как написать математическую статью по-английски. — М.: Изд-во «Факториал Пресс», 2000. — 112 с. ISBN 5-88688-032-1.
• С. С. Кутателадзе. Russian→English in Writing. Советы эпизодическому переводчику. Изд. 7-е, исправл. и допол. — Новосибирск: Институт математики им. С.Л.Соболева Сибирского отделения РАН, 2007. — 196 с.