Подготовка курса Компьютерный практикум по научному письму

Подготовка курса Computer skills for scientific writing.

1 Общая информация

• Название курса:
  • Computer Skills for Scientific Writing
  • Компьютерный практикум по научному письму

2 Ресурсы

• Awesome Scientific Writing: https://project-awesome.org/writing-resources/awesome-scientific-writing.

3 Цель освоения дисциплины

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

4 Планируемые результаты обучения

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

5 Лабораторные работы

• Основы компьютерной подготовки научных публикаций
  • Работа с системой LaTeX
  • Шаблон документа LaTeX. Использование классов и шаблонов
  • Набор математики
  • Вставка изображений
• Расширенные методы подготовки научных публикаций
  • Создание списков и таблиц
  • Работа с библиографией
  • Презентация на базе Beamer
  • Диаграммы и чертежи как код

6 Laboratory work

6.1 LaTeX basics

• Installing LaTeX
  • TeX Live.
• Hello world!
  • Typesetting your first document in TeXworks.

6.2 LaTeX Document Structure

• Structure
  • Structure of a LaTeX file, document classes, packages, topmatter, groups, commands and environments.
• Advanced document structure
  • Writing an article. Chapters, sections, paragraphs, theorems, figures, tables, floats, references, bibliography.
• Basics
  • LaTeX fundamentals
• Writing texts
  • Special characters and accents, paragraphs, non-breaking space, emphasis, lists, verbatim, url and quoting.
• Errors and warnings
  • Error fixing 101.
• Rewriting poor work
  • Exercise in editing

6.3 Mathematics Typing

• Writing mathematical texts
  • Math environment, characters, powers and indices, operators, fractions, roots, dots, matrices, brackets, horizontal whitespace, layout, list of symbols.
• Advanced mathematics
  • Gather, align, matrices, text in mathematical expressions, cases, multiline subscripts, references.

6.4 Inserting Images

6.5 Creating lists and tables

6.6 Working with bibliography

• Bibliography and citations in LaTeX
  • Making a bibliography.
• Proper citations in the text
  • Proper citations in the text.
• BibTex
  • Working with Bibtex.

6.7 Presentation with Beamer

• LaTeX Beamer
  • Presentations with LaTeX Beamer.
• Posters
  • Creating a poster in LaTeX.

6.8 Diagrams and drawings as code

• TikZ
  • Creating images with TikZ.

7 Итоговое тестирование

7.1 Общая информация

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

7.2 Варианты задания

7.2.1 Верстка по образцу

• Студенту выдаётся pdf реальной страницы из научного журнала (сложная таблица, многоуровневая формула, сноски, плавающие объекты).
• Предлагается в точности воспроизвести этот фрагмент в LaTeX за ограниченное время (2 академических часа).
• Критерии результата: визуальное совпадение с оригиналом (наложение скриншотов) + чистый код без хаков, типа \hspace*{...}.

1. Прагматика

   • Проверяет внимание к деталям, знание тонких настроек (выравнивание, отступы, кернинг в формулах, обтекание таблиц).

7.2.2 Отладка

• Студенту даётся готовый, но сломанный архив (папка с .tex, .bib, картинками).

• Он не компилируется или компилируется с ужасным видом.

• Задача: за 90 минут привести проект в идеальный вид.

• Ошибки, которые закладываются:

  • Сломанная кодировка (кракозябры).
  • \cite{...} без добавления .bib или с опечаткой в ключе.
  • Переполнение бокса (overfull \hbox), которое нужно убрать через переносы.
  • Формула, которая не влазит в ширину строки (нужно использовать multline или split).
  • Плавающие рисунки, улетевшие в конец документа (надо исправить [!htbp]).

1. Прагматика

   • 80% времени реальный ученый тратит именно на это, а не на написание текста с нуля.

7.2.3 Мини-препринт

• Это итоговый проект, который длится 1–2 недели.
• Студент пишет короткую научную заметку (2–4 страницы) на тему своей диссертации или курсовой.

1. Технические требования

   1. Использовать стиль конкретного журнала (например, elsarticle или iopart).
   2. Обязательно наличие \label{} и \ref{} для всех формул, таблиц и рисунков (автонумерация).
   3. Библиография строго через BibTeX (стиль unsrt или ieeetr).
   4. Вставить минимум одну сложную формулу с align и нумерацией.
   5. Вставить таблицу, созданную через \pgfplotstable или booktabs с динамическими данными.

2. Защита (устная)

   • Длительность: 5 минут.
   • Студент показывает экран, объясняет, почему выбрал те или иные пакеты, и как боролся с проблемами.

3. Прагматика

   • Это проверяет понимание, а не механическое копирование.

7.2.4 Письмо в редакцию

• Студенту даётся готовый черновик текста.
• Условие: Редактор журнала просит прислать финальную версию строго по шаблону, но у вас нет доступа к интернету (доступен только man-файл дистрибутива).

1. Студент получает

   • Текст (обычный .txt).
   • .cls файл странного журнала (с нестандартными командами).
   • Набор картинок в разных форматах (.png, .pdf).
   • Библиографию в кривом формате.

2. Задание

   • Сверстать PDF и сдать его вместе с логом компиляции.

7.3 Структура оценки

• Возможная структура оценки.

7.4 Подробное описание заданий

7.4.1 Мини-препринт

• Задание имитирует реальную работу по подготовке публикации.

1. Задание для студентов

   • Тема: «Верстка научной заметки по шаблону журнала»

   • Дедлайн: 14 дней с момента выдачи.

   • Формат сдачи:

     • файлы на git: .tex, .bib, все графические файлы;
     • сгенерированный .pdf.

   • Цель: Самостоятельно сверстать короткую научную статью (2–4 страницы) на тему вашего собственного исследования или по предложенной преподавателем теме, строго следуя техническим требованиям современного научного издательства.

   1. Технический чек-лист

      • Документ-класс:
        • Использовать стиль elsarticle (Elsevier) или revtex4-2 (Physical Review). Допускается использование article с подключением geometry для настройки полей, но приветствуется использование готового шаблона.
      • Структура (обязательные секции):
        • \title, \author, \date, \begin{abstract}...\end{abstract}.
        • Минимум 3 секции: \section{Introduction}, \section{Materials and Methods}, \section{Results and Discussion}.
        • \section{Conclusion} и \section*{Acknowledgments}.
      • Работа с библиографией (BibTeX или BibLaTeX)
        • Создать отдельный файл refs.bib с минимум 5 источниками (книги, статьи из журналов).
        • В тексте обязательно использовать \cite{...} для всех источников (каждый источник должен быть процитирован хотя бы раз).
        • Настроить стиль библиографии на \bibliographystyle{unsrt} (нумерация по порядку появления).
      • Математика
        • Вставить одну нумерованную формулу с использованием окружения \begin{equation}...\end{equation}.
        • Вставить многострочную формулу с выравниванием через \begin{align}...\end{align}.
        • Внутри текста обязательно использовать индексы (_), верхние регистры (^) и греческие буквы (например, \alpha, \beta).
      • Таблицы и рисунки
        • Создать одну таблицу, используя пакет booktabs (\toprule, \midrule, \bottomrule). Таблица должна иметь \caption{} и \label{tab:...}.
        • Вставить минимум 2 рисунка (в формате .pdf, .png). Используйте \includegraphics[width=0.8\textwidth]{...}.
      • Перекрёстные ссылки
        • В тексте должны быть ссылки на таблицу (Таблица~\ref{tab:...}) и на рисунок (Рис.~\ref{fig:...}).
      • Качество кода
        • Преамбула должна быть чистой (без мусора из кучи ненужных пакетов пакетов).
        • Используйте только то, что реально нужно.
        • Добавьте 2–3 комментария на русском в .tex файле, поясняющих сложные моменты.

2. Критерии оценки письменной части

   • Работа оценивается по системе 100 баллов.
   • Потом нормализуется на 10 баллов задания.

   №	Критерий	Балл	Примечание
   1	Компилируемость	20	PDF должен собираться без единой ошибки (Error). Предупреждения (Warning) допустимы, но не более 3-х. Если не компилируется — снять все баллы за этот пункт.
   2	Библиография	20	Проверить, что \cite{} работает и генерирует номер. Проверить, что в .bib правильно заполнены поля author, title, journal, year. Стиль должен быть единым.
   3	Математика и таблицы	20	Проверить наличие \label у формул и таблиц. Проверить, работает ли \ref{}. Таблица должна быть построена через booktabs, а не через \hline.
   4	Рисунки и плавающие обьекты	15	Рисунки не должны вылезать за поля. Проверить, что подписи (\caption) идут строго под рисунком/таблицей. Наличие ссылок Рис.~\ref{} в тексте.
   5	Структура и типографика	15	Есть ли титульник? Есть ли разбивка на секции? Проверить, нет ли висячих элементов строки. Нет ли переполнения строк (overfull \hbox в логе).
   6	Чистота кода	10	Открыть .tex. Проверить, разбит ли текст на абзацы пустыми строками. Есть ли комментарии? Подключены ли лишние пакеты.

   1. Рубрика для Moodle

      Критерий	0	3	9	27
      Компилируемость	Не компилируется, PDF отсутствует	Есть ошибки, мешающие работе	Компилируется, но >3 предупреждений	Чистая компиляция, <3 предупреждений
      Библиография	Нет .bib или \cite не работают	.bib есть, но стиль не задан или грубые ошибки	Есть, не тот стиль, не процитированные источники	5+ источников, все процитированы, стиль, поля верны
      Математика и таблицы	Нет формул или таблиц	Есть объекты, но нет \label и ссылок	Объекты, ссылки есть, ошибки	Есть, правильно, все ссылки работают
      Рисунки и плавающие объекты	Рисунков нет или нет \includegraphics	Есть, но нет \ref или \caption не под объектом	Есть, но проблемы с плавающими объектами	2+ рисунка, явные ссылки, хорошее позиционирование
      Структура и типографика	Нет титульника, секций, аннотации	Структура неполная	Все секции есть, висячие строки, переполнения	Полная структура, типографика соблюдена, нет overfull
      Чистота кода	Код нечитаемый, нет комментариев, лишние пакеты	Мало комментариев, есть лишние пакеты	Код чистый, недочёты	Минималистичная преамбула, комментарии, форматирование

8 Используемая литература

8.1 Основная литература

• В качестве основной литературы предлагается использовать [1; 2].

8.2 Дополнительная литература

• В качестве дополнительной литературы предлагается использовать [NO_ITEM_DATA:mittelbach_book_latex-companion_en–5].

9 Библиография

Литература