Изменения

Перейти к: навигация, поиск

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

5061 байт добавлено, 12:38, 21 октября 2011
Новая страница: «{{В разработке}} Всё описанное здесь можно коротко выразить с помощью главного правила Сту...»
{{В разработке}}

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

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

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

= Вообще =
# Не используйте слишком много математических обозначений. Иногда текст понятнее, если его написать по-русски.
# Не лейте воду с помощью рассусоливания русских слов. Лучше напишите строгое и формальное математическое определение.
# Используйте мозг, чтобы выбрать подходящее из первых двух правил.
# Перечитайте конспект через сутки после написания. Переформулируйте все кривые фразы.
# Структурируйте статью. С умом используйте разбиение на абзацы. Не забывайте про заголовки и подзаголовки.
# Используйте шаблоны там, где это надо (для определений, теорем и т.п.).
# Ставьте ссылки на определения терминов, которые используете, но не определяете.
# Оформляйте ссылки на источники [http://ru.wikipedia.org/wiki/%D0%92%D0%B8%D0%BA%D0%B8%D0%BF%D0%B5%D0%B4%D0%B8%D1%8F:%D0%A1%D1%81%D1%8B%D0%BB%D0%BA%D0%B8_%D0%BD%D0%B0_%D0%B8%D1%81%D1%82%D0%BE%D1%87%D0%BD%D0%B8%D0%BA%D0%B8 нормально].

= Теоремы =
# Доказательство должно быть ''чётким'', ''последовательным'' и ''понятным''.
# Не пишите слово «доказательство» — треугольничек в начале означает именно это. Не пишите «что и требовалось доказать» — для этого есть треугольничек в конце.

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

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

Навигация