Участник:Kirelagin/Оформление

Материал из Викиконспекты
Перейти к: навигация, поиск
Эта статья находится в разработке!

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

Всё написанное здесь выражает мою частную позицию. Если вам повезло, и принимать статью у вас буду не я, можете не читать. Главное, чтобы тот, кто будет принимать у вас статью, не решил, что я тут пишу хорошие вещи и не стал проверять по этому моему списку. Так что советую уточнить заранее ;).

Я буду сюда дописывать что-нибудь по мере получения опыта и выявления стандартных паттернов идиотизма, так что заглядывайте иногда.

Вообще[править]

  1. Не используйте слишком много математических обозначений. Иногда текст понятнее, если его написать по-русски.
  2. Не лейте воду с помощью рассусоливания русских слов. Лучше напишите строгое и формальное математическое определение.
  3. Используйте мозг, чтобы выбрать подходящее из первых двух правил.
  4. Перечитайте конспект через сутки после написания. Переформулируйте все кривые фразы.
  5. Структурируйте статью. С умом используйте разбиение на абзацы. Не забывайте про заголовки и подзаголовки.
  6. Используйте шаблоны там, где это надо (для определений, теорем и т.п.).
  7. Ставьте ссылки на определения терминов, которые используете, но не определяете.
  8. Оформляйте ссылки на источники нормально.

Определения[править]

  1. Не надо писать «это» после тире. Кому нужно лишнее слово, когда и так всё понятно?

Теоремы[править]

  1. Доказательство должно быть чётким, последовательным и понятным.
  2. Не пишите слово «доказательство» — это уже написано в шаблоне. Не пишите «что и требовалось доказать» — для этого уже есть треугольничек в конце.
  3. Если в середине доказательства встречается слово «очевидно», скорее всего, в этом переход какой-то нетривиальный и вы сами в нем не разобрались. Все проверяющие это уже давно поняли и потому лучше не привлекайте внимание к мутным местам таким идиотским способом.

Алгоритмы[править]

Если статья посвящена алгоритму, то её надо оформить особенным образом. Мне очень лень писать конкретные правила. Главное — в самом начале статьи должно быть чётко указано, что это за алгоритм, для чего он нужен и какова его асимптотика. Кроме того, должно быть чётко указано, что он принимает на вход, и что даёт на выходе. Пример хорошего оформления можно подсмотреть (только не смейтесь) вот здесь.

Псевдокод[править]

  1. Используйте максимально компактный и читабельный псевдокод. Не используйте реальные языки программирования (особенно, уровня ниже средне-высокого типа Джявы или Си).
  2. Не ставьте фигурные скобки. Угадайте, для чего они нужны? Чтобы парсер языка было легче писать. Человеку они только мешают. Используйте отступы для группировки. (Питон-стайл)
  3. Не ставьте скобки вокруг условия if'а, while'а и т.п.. Угадайте, для чего они нужны? Правильно. (Питон-стайл)
  4. Обозначайте присвоение нормально, с помощью знака «=». (Кормен дурак)[1]
  5. Не вводите какие-то левые операторы. Например, если кладёте что-то в очередь, так и напишите: Q.push(a).

Примечания[править]

  1. На странице обсуждения вот подсказывают, что в третьем издании Кормен уже не дурак.