Справка:Инструкции
Инструкции и требования к написанию вики-конспектов
- Для внесения конспектов нужно зарегистрироваться на сайте и написать в информации о себе имя, фамилию и группу.
- На данный момент регистрация осуществляется через преподавателей:Погожев Сергей Владимирович.
- Внимательно читайте свои конспекты перед тем, как совершать попытку их сдачи. Рекомендуется читать конспекты друг друга перед отправкой на проверку, так как это позволит значительно уменьшить количество итераций сдачи конспекта.
- Не забывайте сообщать преподавателям/редакторам/кураторам о том, что конспект нужно проверить. При общении с редактором давайте ссылку на конспект, который вы пишете. При использовании электронной почты в теме письма указывайте, пожалуйста, “Вики-конспекты: Название вики-конспекта”.
- Редактировать можно не только свои конспекты.
Викификация
- В конспекте не должно быть орфографических, пунктуационных, речевых, фактических, логических и других ошибок.
- Используйте вики-шаблоны Шаблон: Определение, Шаблон: Теорема, Шаблон: Лемма, Шаблон: Утверждение, Шаблон: Следствие, Шаблон: Замечание, Шаблон: Пример (Справка по шаблонам).
- Вместо черточки “-” используйте тире “—”. Для этого можно использовать Шаблон:---. Про правила использования читать здесь
- Приводите английские названия терминов, теорем, имен алгоритмов и т.д. Их лучше писать в скобках курсивом после их русских названий.
- Не используйте без нужды тег <br> . Для перевода строки в вики надо вставлять пустую строку.
- Ставьте категорию, например, [[Категория: Дискретная математика]].
- Оформляйте ссылки на источники правильно.
Картинки
- Предпочтительный формат картинок — векторный. Для этого можно пользоваться Microsoft Visio, Inkscape, Graphviz, Metapost и т.п.
Источники информации
- Используйте ссылки на другие конспекты.
- В конспекте должны быть указаны источники или литература. Причем указывать ссылки не просто на википедию, а на конкретную статью (как Википедия — Экспоненциальная запись, на английскую — как Wikipedia — Scientific notation). Для книг достаточно указать автора, название, издание и номер страницы.
- Нарушения авторского права недопустимы.
TeX
- Формулы обязательно помещаются в тег <math>.
- Википедия:Формулы
- Help:Отображение формул
- Are there any tools to help transcribe mathematical formulae into LaTeX?
- В качестве знака умножения нужно использовать
\times
или\cdot
, а не звездочку. Не следует писать [math]\displaystyle{ 2 * 2 = 4 }[/math], нужно [math]\displaystyle{ 2 \times 2 = 4 }[/math] или [math]\displaystyle{ 2 \cdot 2 = 4 }[/math]. - Не опускайте знаки умножения, конъюнкции, скобки и т.п., если это может привести к неоднозначности.
Псевдокод
- Используйте максимально компактный и читаемый псевдокод.
- Не ставьте фигурные скобки. Используйте отступы для группировки.
- Не ставьте круглые скобки вокруг внешнего условия if'а, while'а и т.п.
- Обозначайте присвоение с помощью знака «=», а сравнение как «==».
- TeX в псевдокоде можно использовать только в случае какого-то нестандартного оператора(а перед этим хорошо подумать и посмотреть предыдущий пункт).
- Оформляйте псевдокод как функцию, принимающую входные данные и возвращающую результат.
- Ставьте пробелы между операндами и бинарными операторами(«1 + 2», а не «1+2»). После унарных операторов перед операндом пробел ставить не нужно.
- Ставьте пробел после запятой, разделяющей аргументы функции.
- Используем какой-то определённый стиль именования переменных(например, lowerCamelCase для переменных и функций, а UpperCamelCase для классов).