Инструменты пользователя

Инструменты сайта


staff:courses:sci_writing:plan

Практические задания (что вам нужно сделать)

Как интерпретировать сроки

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

Для третьего задания - указан дедлайн последней отправки. Не гарантируется проверка PR, отправленных позже срока.

Как называть Pull Request

Правило: <фамилия_инициалы(транслитом)>_<номер_задания>

Пример: Zaslavskiy_MM_2

Общая идея

Практические задания курса преследуют несколько целей:

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

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

Результаты выполнения предшествующих практических заданий могут менятся и переосмыслятся в последующих заданиях, например, нормально скорректировать ответы на ключевые вопросы (задание 1) когда вы приступаете к обзору аналогов (задание 2) и скорректировать ответы (задание 1) и/или обзор (задание 2) при составлении статьи (задание 3).

Отмечать коментарии проверяющего как Resolved не нужно :)

Перед отправкой также полезно проверить орфографию и пунктуацию, например здесь https://languagetool.org/

Задание №1 - выбор темы и ответы на ключевые вопросы

  1. Создайте Pull Request, в котором:
    1. появляется директория /<номер группы>_<фамилия_инициалы(транслитом)>/
    2. в этой директории (если есть) запушены материалы (в формате pdf), на основе которых вы будете готовить статью (например ваши текущие результаты по НИР/ВКР).
    3. создать документ key_questions.md, содержащие описание проблемы, актуальности, ОИ, ПИ, цели, задач, вашего исследования. Объем документа не менее 300 знаков.

Формат документа

# Ответы на ключевые вопросы

## Проблема

## Актуальность

## Объект исследования

## Предмет исследования

## Цель

## Задачи

# Список использованных источников

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

Как ответить на ключевые вопросы - https://stepik.org/lesson/104086/step/1?unit=78652.

Подробнее о проверке задания №1.

Задание №2 - Обзор аналогов

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

# Сравнение аналогов

## Принцип отбора аналогов

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

### <Аналог1>

его краткое описание

…..

### <Аналог5>

его краткое описание

## Критерии сравнения аналогов

### <Критерий 1>

его краткое описание и обоснование

### <Критерий 2>

его краткое описание и обоснование

### <Критерий 3>

его краткое описание и обоснование

## Таблица сравнения аналогов

## Выводы по итогам сравнения

# Выбор метода решения

# Список использованных источников

Нумерованный список источников

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

  1. Бинарные критерии (да/нет, +-, есть нет и тд) недопускаются.
  2. Критерии о бизнес-составляющей вопроса (стоимость решения, наличие перевода на русский язык ….) лучше убрать

По принципу отбора аналогов:

  1. указывайте конкретные поисковые запросы и поисковые системы
  2. в качестве поисковых систем предпочтение отдается системам поиска научных статей, google - последнее средство

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

  1. каким должно быть решение в целом (что должно собой представлять - приложение, скрипт, модель ….),
  2. какими качествами должно обладать решение,
  3. каким способом ваше решение должно удовлетворять критериям из обзора.

Либо, если ваша задача была больше про выбор технологии, опишите в выборе метода решения способ применения (желательно, его тоже опереть на обзор):

  1. (обязательно) чем и каким должно быть решение в целом (что должно собой представлять - приложение, скрипт, модель ….),
  2. каким способом выбранная технология будет использоватся в решении (протоколы, архитектура подключения, паттерны ),
  3. какие эксперименты стоит проделать для оценки качества работы технологии,

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

PullRequest:

  1. в вашем каталоге создан документ analogs.md(не менее 2000 знаков, обязательны ссылки на источники) со структурой, описанной выше (убедитесь, что заголовки совпадают и по уровню, и по названию):
    1. есть характеристика каждого аналога,
    2. есть описание принципа отбора аналогов,
    3. есть описание каждого критерия и обоснование, почему именно он важен для поставленной вами цели / решаемой задачи,
    4. есть таблица сравнения
    5. есть вывод по итогам сравнения,
    6. три критерия,
    7. пять аналогов,
    8. есть не менее пяти ссылок на источники,
    9. есть раздел «Выбор метода решения»

Количество знаков - ориентировочное.

Подробнее о проверке задания №2.

Задание №3 - Сборка статьи

На основании результатов обзора, ответов на ключевые вопросы, а также проработав самостоятельно Описание метода решения и (по желанию) Исследования метода решения, подготовьте оригинальный (оригинальность >= 75%) черновик статьи в форматах .md, .doc/.docx/odt и .pdf (Как сконвертировать MD в DOCX или ODT) со следующей структурой.

!!Внимание!! - данное задание подразумевает не более двух проверок для тех кто сдает в семестре. Результат второй проверки считается окончательным для данного этапа оценивания.

В день качества и на доп сессии ОДНА проверка (при наличии направлений)

# <Название статьи>

Ключевые слова: не менее трех ключевых слов

## Аннотация

## Введение

Содержание данного раздела является развитием «Подготовка ответов на ключевые вопросы».

## <Обзор предметной области == Сравнение аналогов>

## Выбор метода решения

## Описание метода решения (если есть)

## Исследование метода решения (если есть)

## Заключение

## Список использованных источников

Pull-Request (необходимые условия):

  • В вашем каталоге создан документ paper.md
  • и его версия в docx/odt/tex
  • + версия в pdf (paper.docx/odt/tex, paper.pdf)).
  • Созданы все необходимые разделы.
  • Аннотация написана в совершенном времени.
  • Между разделами есть смысловые связки.
  • Выполнены требования Задания №1 ( == в статье поставлена цель, обозначены задачи, присутствует проблема, понятен предмет и объект исследования).
  • Выполнены требования Задания №2 ( == в статье есть обзор).
  • В Выводах описан краткий результат решения каждой из поставленных Задач.
  • Каждое ключевое слово упоминается в основном тексте хотя бы один раз.
  • Все элементы списка литературы имеют минимум одно упоминание в тексте (вот так [1]).
  • Все рисунки имеют подрисуночные подписи и ссылки в тексте.
  • Все таблицы имеют подписи и ссылки в тексте.

Если ваша статья изначально - обзор, то опишите в «Описании метода решения» краткую архитектуру будущего решения / возможные модули / идеи по построению решения.

Советы:

  • Опирайте Введение на результаты первого задания.
  • Отражайте в Заключении фактические результаты по вашим задачам. Если результаты получились не очень, то возможно нужно поправить задачи.
  • Убедитесь, что «Выбор метода решения» плотно опирается на Обзор и Ответы на ключевые вопросы. Если в нем появляются требования, которые не обосновываются предыдущим материалом статьи, то это ~99% будет замечание:(
  • Пишите Аннотацию по делу (без исторических справок) и после подготовки остального текста

Подробнее о критериях проверки задания №3 (статья).