Difference between revisions of "Week 9"
From Research management course
m (→Резензент:) |
|||
| Line 29: | Line 29: | ||
===При рецензировании исходного текста и кода=== | ===При рецензировании исходного текста и кода=== | ||
Рецензент | Рецензент | ||
| − | + | * в тексте статьи ставит пометки <nowiki>\footnote{Замечание к статье}</nowiki>, | |
| − | + | * в файлах-исходниках ставит пометки <nowiki>% FIXIT Замечание к коду</nowiki>. | |
Автор | Автор | ||
| − | * | + | * в статье вносит требуемые исправления и снимает пометки \footnote{Замечание к статье}, |
| − | * | + | * в файлах-исходниках вносит требуемые исправления и исправляет пометки<nowiki> % FIXIT на %FIXED</nowiki>. |
===Соглашение о комментировании=== | ===Соглашение о комментировании=== | ||
Revision as of 14:43, 3 April 2021
Contents
W: Review
Автор:
- проверяет, что последняя версия статьи загружена и
- она соответствует требованиям прошлой недели.
Рецензент:
- Ставит свою фамилию в таблице на странице группы.
- Загружает рецензию в свою папку doc/, см.
- Рецензия не обязательно содержит описание рецензируемой работы, но содержит
- мнение рецензента о новизне, актуальности и обоснованности работы, а также
- список ошибок, недочетов и замечаний, призванных улучшить качество статьи.
Рецензент проверяет следующие критерии
- Ясность основного сообщения, наличие единого объекта исследования
- Точность терминов, связность изложения
- Стандартность, непротиворечивость и ясность обозначений
- Соответствие цели и содержания эксперимента поставленной задаче
- Полнота анализа ошибки
- Повторяемость эксперимента:
- основной алгоритм восстанавливается из математического описания или из псевдокода без помощи автора,
- код читается легко, есть его описания, основной модуль легко найти, он запускает базовый вариант эксперимента,
- в статье есть ссылка на код и на выборку.
Рецензент отвечает за качество работы, но должен быть благожелателен к исполнителю. Критерий качества работы: рецензент с удовольствием готов использовать рецензируемую работу для решения своих задач.
При рецензировании исходного текста и кода
Рецензент
- в тексте статьи ставит пометки \footnote{Замечание к статье},
- в файлах-исходниках ставит пометки % FIXIT Замечание к коду.
Автор
- в статье вносит требуемые исправления и снимает пометки \footnote{Замечание к статье},
- в файлах-исходниках вносит требуемые исправления и исправляет пометки % FIXIT на %FIXED.
Соглашение о комментировании
Приняты следующие комментарии, добавляемые в код при его проверке:
- % FIXIT – желательно изменить код (улучшить структуру кода или устранить ошибку),
- % FIXED – устраненные ошибки или улучшенный код,
- % NOTE – комментарий для обмена мнениями,
- % TODO – желательно выполнить работу.
Resources
- [Video for week 9].
- [Slides for week 9].
- Шаблон рецензии Surname2018Title_Review.rtf.
- Примеры рецензий, которые обсуждались на лекции.