Руководство по написанию научно-технической работы

A Guide for Writing a Technical Research Paper
Libby Shoop
Macalester College, Mathematics
and Computer Science Department

1. Введение

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

2 Что такое исследование?

Краткое определение исследований, данное Booth, Colomb и Williams (Booth et al., 1995), - это «сбор информации, необходимой для ответа на вопрос, и тем самым помочь вам решить проблему» (стр. 6). Вы все нашли проблему, которая вам интересна и занята сбором информации, чтобы помочь вам ответить на вопросы, с которыми вы столкнулись на этом пути. Вы должны собирать эту информацию из надежных источников, таких как статьи из реферируемых журналов, статьи из отредактированных журналов из профессиональных обществ, статьи из реферируемых материалов конференций и книг (например, изучение специализированной литературы по искусству для написания сочинения по картине). Вы должны знать, что статьи, опубликованные только в Интернете, не обязательно считаются надежными источниками и должны использоваться экономно.

3 Понимание ваших читателей

Хотя вы тесно сотрудничаете с вашим советником по науке, который в первую очередь читает ваши черновики, вы должны писать для более широкой аудитории. Вы хотите писать со своими читателями. В вашем случае ваши читатели могут быть профессионалами, которые знакомы с вашей темой, или они могут быть более общей аудиторией, которые могут или не могут иметь разные уровни понимания вашей тематической области. Бут, Коломб и Уильямс (Booth et al., 1995) предполагают, что вы должны учитывать следующие вопросы во время написания:

• Кто ваши читатели?
• Чего они ожидают от вас? В вашем случае вы пытаетесь сообщить их, а не развлекать их.
• Насколько они знают?
• Они уже понимают вашу проблему / вопрос? Вы не должны предполагать это в своей статье - вы должны предоставить некоторые сведения и объяснения того, что вы изучили.
• Как они будут реагировать на ваше решение / ответ? Вы должны попытаться предвидеть вопросы или недоразумения, которые они могут иметь, и предоставить достаточное объяснение, чтобы избежать их.
• На каком форуме они столкнутся с вашим отчетом? Вы должны написать свой технический исследовательский документ, как если бы он мог быть опубликован в журнале, журнале профессионального общества или в конференциях. Из-за этого существуют некоторые стандарты форматирования, которые вы должны использовать, и обсуждаются позже.

4 Определите и определите свою тему

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

• Где визуализация базы данных в более широкой теме визуализации информации?
• Найден ли он в каких-либо других категориях исследований? Связано ли это с другими областями исследований?
• Какова история визуализации базы данных?
• Кто добился успехов в визуализации базы данных?
• Каково значение этих достижений? Почему их результаты были важны?
• Какая польза от визуализации базы данных? Что он может сделать для вас?

На эти вопросы вы найдете много ответов, и ваша задача - сузить то, что вы планируете использовать для чего-то управляемого. Последний пункт выше - тот, который будет иметь как положительные, так и отрицательные ответы. Другим важным аспектом этого последнего элемента является определение того, кто вы есть. Это могут быть ваши читатели, но это может быть определенная группа пользователей. Возможно, также, что такие вопросы не имеют практического значения. Это не значит, что это не достойно исследований.
Затем вы должны попытаться уточнить эти вопросы в более конкретных и начать разработку ответов. Возможно, вы даже решите, что визуализация базы данных в качестве темы слишком широка, и что вы сосредоточитесь на «Архитектурной поддержке визуализации базы данных», тем самым устраняя такие темы, как новые методы визуализации базы данных и концентрируясь на аспектах компьютерной системы визуализации базы данных. В качестве примера того, как усовершенствовать вышеуказанные вопросы, мы могли бы начать со следующих идей:
Сегодня многие базы данных имеют большое количество данных.
Люди, которым необходимо анализировать эти данные, испытывают трудности с анализом его в своей родной форме, которая является табличной. Общие характеристики набора данных трудно распознать при просеивании через миллионы строк в таблице.
Аналогичной проблеме сталкиваются ученые с очень большими вычислительными наборами данных, такими как моделирование потока жидкости. В научной визуализации значительные достижения были достигнуты в программном обеспечении для графического оборудования и визуализации, что позволило этим ученым увидеть тенденции и важные точки данных в своих наборах данных.
Исследование визуализации базы данных стремится найти сопоставления из табличных данных базы данных на визуальные дисплеи, которые позволят аналитикам баз данных, отличных от научных данных, видеть тенденции, выбросы, аномалии и шаблоны в своих данных.
Ahlberg и Schneiderman (Ahlberg and Schneiderman, 1994) смогли объединить методы для определения запросов к базе данных с использованием элементов графического интерфейса пользователя с двумерными дисплеями рассеянного экрана в единый инструмент визуализации интерактивной базы данных. Их результат был важен, поскольку он был одним из первых случаев определения связи между запросами базы данных и соответствующей интерактивной визуализацией, которая сразу показывала множество точек данных.
С этими утверждениями вы начали отвечать на некоторые из более крупных вопросов, указанных выше. Обратите внимание, что вы определили, кто может извлечь выгоду из исследований в этой области. Во время процесса очистки вы продолжите описывать, как отдельные исследователи (и, возможно, сами, если вам повезет) разработали технику или описали метод, который позволит пользователям инструментов или методов визуализации базы данных анализировать свои данные таким образом, чтобы ранее невозможно, и вы расскажете, почему их продвижение было важно.
В конце концов, вы также собираетесь разработать некоторые идеи для того, что еще нужно сделать и что еще не было решено. Вы также начнете определять эти идеи, что может привести к проблеме исследования, которую вы хотели бы решить. Мы не ожидаем, что это произойдет в какой-либо значительной мере для большинства проектов capstone, но вы должны искать его. Даже если вы не можете внедрить новый метод или завершить доказательство, вы все равно сможете сформулировать, какие исследования еще нужно сделать, и вы даже можете описать возможные решения.
Чтобы сузить тему и то, что вы сообщите об этом, вы должны найти ответы на вопросы, которые вы считаете незначительными или не касаетесь основной проблемы, к которой вы пытаетесь обратиться. Поэтому также важно подумать об этой проблеме.

5 Из вопросов к постановке задачи

После того, как вы начнете формулировать ответы на некоторые из вопросов, о которых я упоминал ранее, вы можете приступить к формулированию общего заявления о проблеме в вашей теме. Определение проблемы, с которой вы обращаетесь, может быть борьбой, но это важно по нескольким причинам. Это должно помочь вам оставаться на курсе и не заходить слишком далеко. Это должно позволить вам кратко описать своих читателей и всех, кто спрашивает, что вы изучали и почему. По мере того, как вы боретесь и улучшаетесь, вы будете развивать навык, который вы найдете полезным позже в жизни, независимо от того, проводите ли вы исследование или работаете ли у кого-то, у кого есть проблема для вас.
Следующее - это форма, которая должна следовать за разработкой постановки задачи, как это предлагает Бут, Коломб и Уильямс (Booth et al., 1995). Я рекомендую вам найти копию этой книги и посмотреть, что они скажут об этом в главе 4. В этой книге также есть и другая очень полезная информация о написании научной статьи, только некоторые из которых я смогу охватить этот документ.

1. Назовите свою тему:
Я пишу о ...
2. Укажите свой косвенный вопрос (и тем самым определите условие своей проблемы):
... потому что я пытаюсь показать вам, кто / как / почему
3. Укажите, как ваш ответ поможет вашему читателю понять что-то еще более важное (и тем самым определить стоимость незнания ответа):
... чтобы объяснить вам, как / почему.

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

6 Поддержка вашей позиции

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

Большая часть того, о чем я говорил до сих пор, связана с разработкой ваших требований. Важно, чтобы вы хорошо сформулировали это. Это ваши доказательства, подтверждающие ваши утверждения, которые составляют основную часть вашей статьи. Вы должны убедить своих читателей, что ваше утверждение верно, потому что ваши подтверждающие доказательства, по словам Бута, Колумба и Уильямса, «точные, точные, достаточные, представительные, авторитетные и проницательные» (Booth et al., 1995). Perspicuity означает, что пользователи видят то, что вы хотите, чтобы они видели данные или другие данные. В седьмой главе этой книги подробно описываются эти и другие понятия.

Самое важное, что нужно помнить о том, чтобы поддержать ваши претензии доказательствами, заключается в том, что вы предоставляете источники заявлений о факте, которые вы делаете. Вы делаете это, ссылаясь на литературу в своем тексте. Например, я мог бы сделать следующее заявление в документе:

Человеческое взаимодействие и вмешательство имеют решающее значение для эффективности визуализации финансовых данных (Lux, 1997) и для исследования многомерных пространств данных (Ahlberg and Schneiderman, 1994).

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

7 Формат бумаги

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

7.1 Название

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

7.2 Аннотация

Вы не должны писать это, пока ваша бумага не будет завершена. Резюме должно содержать основные сообщения вашей статьи, в виде определения проблемы, которую вы исследовали, и какие ваши выводы были на очень высоком уровне. Если у вас есть свои собственные достижения, они должны быть описаны на высоком уровне. Ни в коем случае не следует копировать предложения из своей статьи в реферат. Вы пишете на гораздо более высоком уровне здесь. Чтобы понять это, прочитайте несколько тезисов из документов, которые вы собрали во время своих исследований. Резюме короткое - не более 250-300 слов - поэтому вам нужно быть кратким.

7.3 Введение

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

Ahlberg и Schneiderman (Ahlberg and Schneiderman, 1994) смогли объединить методы для определения запросов к базе данных с использованием элементов графического интерфейса пользователя с двумерными дисплеями рассеянного экрана в единый инструмент визуализации интерактивной базы данных.

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

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

7.4 Предыстория и мотивация [необязательно]

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

7.5 Разделы с именами по вашему выбору

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

Формальная научная статья в других дисциплинах, таких как Биология, содержит следующие разделы: Методология, результаты, обсуждение. Хотя мы часто отклоняемся от использования этих разделов в Math and Computer Science, общая концепция все еще существует. Вы должны объяснить, что вы сделали, что привело, и дать обсуждение этих результатов. Этот формат будет относиться к тем немногим из вас, кто может выполнить некоторые вычислительные эксперименты (если вы протестировали несколько алгоритмов, чтобы определить их скорость выполнения, например).

7.6 Обсуждение и будущая работа

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

7.7 Заключение

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

7.8 Ссылки

Некоторые люди называют этот раздел «Ссылки цитируются», «Литература цитируется» или «Избранная библиография». Технически некорректно просто называть это библиографией, потому что это относится ко всем литературным цитатам по любому конкретному предмету. В этом разделе будут содержаться только ссылки на работы, приведенные в вашем документе. Вместо этого раздела вы не должны использовать сноски или концевые заметки. Существует несколько форматов, приемлемых для этого раздела, и соответствующие способы ссылки на эти записи в тексте. Вы должны выбрать один метод и придерживаться его. В «Чикагском руководстве стиля» (University of Chicago Press, 1993) приводятся примеры. Существуют также другие форматы стилей, которые хорошо описаны в справочнике писателя на веб-странице Центра написания UW-Madison (University of Wisconsin Writing Center, 2003). Библиотека Macalester разработала веб-страницу онлайн-ссылок на стиль (Macalester College Library Staff, 2003), и я рекомендую вам обратиться за дополнительной информацией. Это включает в себя ссылку на «Руководство Columbia Guide to Online Style» (Columbia University Press, 2003) и другие сайты, которые помогут вам отформатировать ваши ссылки на онлайн-материалы, такие как документы в Интернете, списки обсуждений и группы новостей. Вы увидите, что я использовал стили, задокументированные там, для источников веб-страниц, представленных в этой статье.

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

Если вы используете программное обеспечение, такое как латекс и бибтекс или концевая сноска, процесс организации ваших ссылок может быть проще. Я построил эту бумагу, используя латекс и бибтекс на линейной машине, и выбрал стиль APA. Существуют и другие стили, которые вы могли бы использовать вместо этого. Например, я мог бы легко переработать этот документ со стилем IEEE и создать документ со стилем, который Институт электротехники и электроники требует для своих публикаций.

Использованные источники

  1. Ahlberg, C. and Schneiderman, B. (1994). Visual information seeking: tight coupling of dynamic query filters with starfield displays. In Proceedings of the ACM CHI9´2 Conference, pages 313–317.

  2. Booth, W. C., Colomb, G. C., and Williams, J. M. (1995). The Craft of Research. The University of Chicago Press. ISBN: 0-226-06584-7.

  3. Columbia University Press (2003). Columbia guide to online style. columbia.edu/cu/cup/cgos/idx basic.html (2 Feb. 2003.

  4. Lux, M. (1997). Visualization of financial data. In Proceedings of the Workshop on New paradigms in Information Visualization, pages 58–61.

  5. Macalester College Library Staff (2003). Citing resources and preparing publications. macalester.edu/library/research/general/citing.html (2 Feb. 2003).

  6. Turabian, K. L. (1996). A  Manual for  Writers of  Term Papers,  Theses, and  Dissertations (Chicago  Guides to Writing, Editing, and Publishing). University of Chicago Press. ISBN: 0226816273.

  7. University of Chicago Press (1993). The Chicago Manual of Style. The University of Chicago Press, 14th edition. In Mac Library Reference Section.

  8. University of Wisconsin Writing Center (2003). Writer’s handbook. wisc.edu/writing/Handbook/Documentation.html (2 Feb. 2003).

  9. White, E., Angell, R., and Strunk, W. (1999). The Elements of Style. Allyn & Bacon, 4th edition. ISBN: 0205313426.

  10. Williams, J. M. (2000). Style, Ten Lessons in Clarity and Grace. Addison Wesley Longman, 6th edition. ISBN: 0-321-02408-7.