Week 9

From My first scientific paper
Jump to: navigation, search

W: Review

Автор

  1. Проверяет, что последняя версия статьи загружена и
  2. она соответствует требованиям прошлой недели.

Цель этой недели: написать рецензию на работу.

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

Рецензент

  1. Ставит свою фамилию в таблице на странице группы.
  2. Загружает рецензию в свою папку doc/, см.
  3. Рецензия не обязательно содержит описание рецензируемой работы, но содержит
    • мнение рецензента о новизне, актуальности и обоснованности работы, а также
    • список ошибок, недочетов и замечаний, призванных улучшить качество статьи.

Рецензент проверяет следующие критерии

  1. Ясность основного сообщения, наличие единого объекта исследования
  2. Точность терминов, связность изложения
  3. Стандартность, непротиворечивость и ясность обозначений
  4. Соответствие цели и содержания эксперимента поставленной задаче
  5. Полнота анализа ошибки
  6. Повторяемость эксперимента:
    1. основной алгоритм восстанавливается из математического описания или из псевдокода без помощи автора,
    2. код читается легко, есть его описания, основной модуль легко найти, он запускает базовый вариант эксперимента,
    3. в статье есть ссылка на код и на выборку.

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

При рецензировании исходного текста и кода

Рецензент

  • в тексте статьи ставит пометки \footnote{Замечание к статье},
  • в файлах-исходниках ставит пометки % FIXIT Замечание к коду.

Автор

  • в статье вносит требуемые исправления и к пометкам \footnote{Замечание к статье – Ответы на замечания} добавляет ответы рецензенту,
  • в файлах-исходниках вносит требуемые исправления и исправляет пометки % FIXIT на %FIXED, добавляя ответы рецензенту.

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

Соглашение о комментировании

Приняты следующие комментарии, добавляемые в код при его проверке:

  •  % FIXIT – желательно изменить код (улучшить структуру кода или устранить ошибку),
  •  % FIXED – устраненные ошибки или улучшенный код,
  •  % NOTE – комментарий для обмена мнениями,
  •  % TODO – желательно выполнить работу.

Resources