Обсуждение:Дискретная математика и алгоритмы — различия между версиями

Материал из Викиконспекты
Перейти к: навигация, поиск
(отсортировал по категориям, добавил правила оформления псевдокода)
Строка 1: Строка 1:
 
Требования к написанию вики-конспектов 1 курса.
 
Требования к написанию вики-конспектов 1 курса.
  
 +
== Главное ==
 
* '''Внимательно читайте свои конспекты перед тем, как совершать попытку их сдачи.'''
 
* '''Внимательно читайте свои конспекты перед тем, как совершать попытку их сдачи.'''
 +
* '''Перед отправкой на проверку перечитайте эти требования.'''
 +
 +
== Общение с редакторами ==
 +
* Будет лучше, если вы зарегистрируетесь на сайте вики-конспектов и напишете в информации о себе имя, фамилию и группу.
 +
* Не забывайте сообщать редакторам о том, что конспект нужно проверить.
 +
* При общении с редактором, представляйтесь и указывайте какой конспект вы пишете. В теме письма указывайте “Вики-конспекты: Название вики-конспекта”.
 +
* Ставить замечания к конспекту может не только ваш редактор, в том числе и после принятия конспекта. Их тоже надо учитывать.
 +
 +
== Викификация ==
 
* Смотрите в качестве примера на конспекты, которые отмечены как хорошие.
 
* Смотрите в качестве примера на конспекты, которые отмечены как хорошие.
 
* В конспекте не должно быть орфографических, пунктуационных, речевых, фактических, логических и других ошибок. Используйте spell checker.
 
* В конспекте не должно быть орфографических, пунктуационных, речевых, фактических, логических и других ошибок. Используйте spell checker.
 
* Используйте вики-шаблоны [[Шаблон: Определение]], [[Шаблон: Теорема]], [[Шаблон: Лемма]], [[Шаблон: Утверждение]] (примеры использования смотрите в других конспектах).
 
* Используйте вики-шаблоны [[Шаблон: Определение]], [[Шаблон: Теорема]], [[Шаблон: Лемма]], [[Шаблон: Утверждение]] (примеры использования смотрите в других конспектах).
 +
* Приводите английские названия терминов, теорем, имен алгоритмов и т.д. Их лучше писать в скобках курсивом после их русских названий.
 +
* Вместо черточки “-” используйте тире “{{---}}”. Для этого можно использовать [[Шаблон :---]]
 +
* Редактировать можно не только свои конспекты — используйте “концепцию вики”
 +
* Не используйте тег <nowiki> <br> </nowiki>. Для перевода строки в вики надо вставлять пустую строку.
 +
* Ставьте категорию <nowiki>[[Категория: Дискретная математика и алгоритмы]]</nowiki> и подкатегорию с названием подтемы (например, <nowiki>[[Категория: Динамическое программирование]]</nowiki>). Список подкатегорий [[:Категория:Дискретная математика и алгоритмы | тут]].
 +
 +
== Источники ==
 
* Используйте ссылки на другие конспекты.
 
* Используйте ссылки на другие конспекты.
 
* В конспекте должны быть указаны источники или литература. Причем указывать ссылки не просто на википедию, а на конкретную статью(как [http://ru.wikipedia.org/wiki/%D0%AD%D0%BA%D1%81%D0%BF%D0%BE%D0%BD%D0%B5%D0%BD%D1%86%D0%B8%D0%B0%D0%BB%D1%8C%D0%BD%D0%B0%D1%8F_%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D1%8C Википедия - Экспоненциальная запись], на английскую {{---}} как [http://en.wikipedia.org/wiki/Scientific_notation Wikipedia - Scientific notation]). Для книг достаточно указать автора, название, издание и номер страницы.
 
* В конспекте должны быть указаны источники или литература. Причем указывать ссылки не просто на википедию, а на конкретную статью(как [http://ru.wikipedia.org/wiki/%D0%AD%D0%BA%D1%81%D0%BF%D0%BE%D0%BD%D0%B5%D0%BD%D1%86%D0%B8%D0%B0%D0%BB%D1%8C%D0%BD%D0%B0%D1%8F_%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D1%8C Википедия - Экспоненциальная запись], на английскую {{---}} как [http://en.wikipedia.org/wiki/Scientific_notation Wikipedia - Scientific notation]). Для книг достаточно указать автора, название, издание и номер страницы.
* Приводите английские названия терминов, теорем, имен алгоритмов и т.д. Их лучше писать в скобках курсивом после их русских названий.
+
 
* Будет лучше, если вы зарегистрируетесь на сайте вики-конспектов и напишете в информации о себе имя, фамилию и группу.
+
== TeX ==
 
* Использование тега <nowiki><tex></nowiki> вместо <nowiki><math></nowiki> обязательно. Без тега tex можно писать только переменные сами по себе (a, b, n, i, T и т.д.) и названия функций в пояснениях к псевдокоду.
 
* Использование тега <nowiki><tex></nowiki> вместо <nowiki><math></nowiki> обязательно. Без тега tex можно писать только переменные сами по себе (a, b, n, i, T и т.д.) и названия функций в пояснениях к псевдокоду.
 
* Если лень постоянно писать <nowiki> <tex> </tex> </nowiki> , можно обернуть всю статью в <nowiki> <wikitex> </wikitex> </nowiki>, а потом обособлять формулы в $ $(например, <nowiki> <wikitex> Для любого $ \alpha $ верно $\sin^2 \alpha + \cos^2 \alpha = 1 $ </wikitex> </nowiki>).  
 
* Если лень постоянно писать <nowiki> <tex> </tex> </nowiki> , можно обернуть всю статью в <nowiki> <wikitex> </wikitex> </nowiki>, а потом обособлять формулы в $ $(например, <nowiki> <wikitex> Для любого $ \alpha $ верно $\sin^2 \alpha + \cos^2 \alpha = 1 $ </wikitex> </nowiki>).  
 
* Формулы с дробями нужно увеличивать для повышения читаемости, особенно, если их много в конспекте. Для этого используйте параметр dpi в теге tex. Пример: <nowiki> <tex dpi = "180">\frac {\omega_n(x)} {(x - x_j) \cdot \omega_n'(x_j)}</tex> </nowiki>
 
* Формулы с дробями нужно увеличивать для повышения читаемости, особенно, если их много в конспекте. Для этого используйте параметр dpi в теге tex. Пример: <nowiki> <tex dpi = "180">\frac {\omega_n(x)} {(x - x_j) \cdot \omega_n'(x_j)}</tex> </nowiki>
* Вместо черточки “-” используйте тире “{{---}}”. Для этого можно использовать [[Шаблон :---]]
+
 
* Редактировать можно не только свои конспекты — используйте “концепцию вики”
+
== Псевдокод ==
* Не используйте тег <nowiki> <br> </nowiki>. Для перевода строки в вики надо вставлять пустую строку.
+
(правила, в основном, отсюда [[Участник: Kirelagin/Оформление#Псевдокод]])
* Ставьте категорию <nowiki>[[Категория: Дискретная математика и алгоритмы]]</nowiki> и подкатегорию с названием подтемы (например, <nowiki>[[Категория: Динамическое программирование]]</nowiki>). Список подкатегорий [[:Категория:Дискретная математика и алгоритмы | тут]].
+
* Используйте максимально компактный и читаемый псевдокод.
* Не забывайте сообщать редакторам о том, что конспект нужно проверить.
+
* Не ставьте фигурные скобки. Угадайте, для чего они нужны? Чтобы парсер языка было легче писать. Человеку они только мешают. Используйте отступы для группировки. (Python-style)
* При общении с редактором, представляйтесь и указывайте какой конспект вы пишете. В теме письма указывайте “Вики-конспекты: Название вики-конспекта”.
+
* Не ставьте круглые скобки вокруг внешнего условия if'а, while'а и т.п.
* Ставить замечания к конспекту может не только ваш редактор, в том числе и после принятия конспекта. Их тоже надо учитывать.
+
* Обозначайте присвоение ''нормально'', с помощью знака «=».
* '''Перед отправкой на проверку перечитайте эти требования.'''
+
* Не вводите какие-то левые операторы. Например, если кладёте что-то в очередь, так и напишите: Q.push(a).
 +
* TeX в псевдокоде можно использовать только в случае какого-то нестандартного оператора(а перед этим хорошо подумать и посмотреть предыдущий пункт)

Версия 01:43, 26 октября 2011

Требования к написанию вики-конспектов 1 курса.

Главное

  • Внимательно читайте свои конспекты перед тем, как совершать попытку их сдачи.
  • Перед отправкой на проверку перечитайте эти требования.

Общение с редакторами

  • Будет лучше, если вы зарегистрируетесь на сайте вики-конспектов и напишете в информации о себе имя, фамилию и группу.
  • Не забывайте сообщать редакторам о том, что конспект нужно проверить.
  • При общении с редактором, представляйтесь и указывайте какой конспект вы пишете. В теме письма указывайте “Вики-конспекты: Название вики-конспекта”.
  • Ставить замечания к конспекту может не только ваш редактор, в том числе и после принятия конспекта. Их тоже надо учитывать.

Викификация

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

Источники

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

TeX

  • Использование тега <tex> вместо <math> обязательно. Без тега tex можно писать только переменные сами по себе (a, b, n, i, T и т.д.) и названия функций в пояснениях к псевдокоду.
  • Если лень постоянно писать <tex> </tex> , можно обернуть всю статью в <wikitex> </wikitex> , а потом обособлять формулы в $ $(например, <wikitex> Для любого $ \alpha $ верно $\sin^2 \alpha + \cos^2 \alpha = 1 $ </wikitex> ).
  • Формулы с дробями нужно увеличивать для повышения читаемости, особенно, если их много в конспекте. Для этого используйте параметр dpi в теге tex. Пример: <tex dpi = "180">\frac {\omega_n(x)} {(x - x_j) \cdot \omega_n'(x_j)}</tex>

Псевдокод

(правила, в основном, отсюда Участник: Kirelagin/Оформление#Псевдокод)

  • Используйте максимально компактный и читаемый псевдокод.
  • Не ставьте фигурные скобки. Угадайте, для чего они нужны? Чтобы парсер языка было легче писать. Человеку они только мешают. Используйте отступы для группировки. (Python-style)
  • Не ставьте круглые скобки вокруг внешнего условия if'а, while'а и т.п.
  • Обозначайте присвоение нормально, с помощью знака «=».
  • Не вводите какие-то левые операторы. Например, если кладёте что-то в очередь, так и напишите: Q.push(a).
  • TeX в псевдокоде можно использовать только в случае какого-то нестандартного оператора(а перед этим хорошо подумать и посмотреть предыдущий пункт)