Справка:Инструкции

Материал из Викиконспекты ПМ-ПУ

Инструкции и требования к написанию вики-конспектов

  1. Для внесения конспектов нужно зарегистрироваться на сайте и написать в информации о себе имя, фамилию и группу.
  2. На данный момент регистрация осуществляется через преподавателей:Погожев Сергей Владимирович.
  3. Внимательно читайте свои конспекты перед тем, как совершать попытку их сдачи. Рекомендуется читать конспекты друг друга перед отправкой на проверку, так как это позволит значительно уменьшить количество итераций сдачи конспекта.
  4. Не забывайте сообщать преподавателям/редакторам/кураторам о том, что конспект нужно проверить. При общении с редактором давайте ссылку на конспект, который вы пишете. При использовании электронной почты в теме письма указывайте, пожалуйста, “Вики-конспекты: Название вики-конспекта”.
  5. Редактировать можно не только свои конспекты.

Викификация

  1. В конспекте не должно быть орфографических, пунктуационных, речевых, фактических, логических и других ошибок.
  2. Используйте вики-шаблоны Шаблон: Определение, Шаблон: Теорема, Шаблон: Лемма, Шаблон: Утверждение, Шаблон: Следствие, Шаблон: Замечание, Шаблон: Пример (Справка по шаблонам).
  3. Вместо черточки “-” используйте тире “—”. Для этого можно использовать Шаблон:---. Про правила использования читать здесь
  4. Приводите английские названия терминов, теорем, имен алгоритмов и т.д. Их лучше писать в скобках курсивом после их русских названий.
  5. Не используйте без нужды тег <br> . Для перевода строки в вики надо вставлять пустую строку.
  6. Ставьте категорию, например, [[Категория: Дискретная математика]].
  7. Оформляйте ссылки на источники правильно.

Картинки

  1. Предпочтительный формат картинок — векторный. Для этого можно пользоваться Microsoft Visio, Inkscape, Graphviz, Metapost и т.п.

Источники информации

  1. Используйте ссылки на другие конспекты.
  2. В конспекте должны быть указаны источники или литература. Причем указывать ссылки не просто на википедию, а на конкретную статью (как Википедия — Экспоненциальная запись, на английскую — как Wikipedia — Scientific notation). Для книг достаточно указать автора, название, издание и номер страницы.
  3. Нарушения авторского права недопустимы.

TeX

  1. Формулы обязательно помещаются в тег <math>.
  2. Википедия:Формулы
  3. Help:Отображение формул
  4. Are there any tools to help transcribe mathematical formulae into LaTeX?
  5. В качестве знака умножения нужно использовать \times или \cdot, а не звездочку. Не следует писать [math]\displaystyle{ 2 * 2 = 4 }[/math], нужно [math]\displaystyle{ 2 \times 2 = 4 }[/math] или [math]\displaystyle{ 2 \cdot 2 = 4 }[/math].
  6. Не опускайте знаки умножения, конъюнкции, скобки и т.п., если это может привести к неоднозначности.

Псевдокод

  1. Используйте максимально компактный и читаемый псевдокод.
  2. Не ставьте фигурные скобки. Используйте отступы для группировки.
  3. Не ставьте круглые скобки вокруг внешнего условия if'а, while'а и т.п.
  4. Обозначайте присвоение с помощью знака «=», а сравнение как «==».
  5. TeX в псевдокоде можно использовать только в случае какого-то нестандартного оператора(а перед этим хорошо подумать и посмотреть предыдущий пункт).
  6. Оформляйте псевдокод как функцию, принимающую входные данные и возвращающую результат.
  7. Ставьте пробелы между операндами и бинарными операторами(«1 + 2», а не «1+2»). После унарных операторов перед операндом пробел ставить не нужно.
  8. Ставьте пробел после запятой, разделяющей аргументы функции.
  9. Используем какой-то определённый стиль именования переменных(например, lowerCamelCase для переменных и функций, а UpperCamelCase для классов).