Участник:Kirelagin/Оформление — различия между версиями
Kirelagin (обсуждение | вклад) (→Теоремы) |
Kirelagin (обсуждение | вклад) (Сделал заголовки помельче) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 7: | Строка 7: | ||
Я буду сюда дописывать что-нибудь по мере получения опыта и выявления стандартных паттернов идиотизма, так что заглядывайте иногда. | Я буду сюда дописывать что-нибудь по мере получения опыта и выявления стандартных паттернов идиотизма, так что заглядывайте иногда. | ||
| − | = Вообще = | + | == Вообще == |
# Не используйте слишком много математических обозначений. Иногда текст понятнее, если его написать по-русски. | # Не используйте слишком много математических обозначений. Иногда текст понятнее, если его написать по-русски. | ||
# Не лейте воду с помощью рассусоливания русских слов. Лучше напишите строгое и формальное математическое определение. | # Не лейте воду с помощью рассусоливания русских слов. Лучше напишите строгое и формальное математическое определение. | ||
| Строка 17: | Строка 17: | ||
# Оформляйте ссылки на источники [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 нормально]. | # Оформляйте ссылки на источники [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 нормально]. | ||
| − | = Определения = | + | == Определения == |
# Не надо писать «это» после тире. Кому нужно лишнее слово, когда и так всё понятно? | # Не надо писать «это» после тире. Кому нужно лишнее слово, когда и так всё понятно? | ||
| − | = Теоремы = | + | == Теоремы == |
# Доказательство должно быть ''чётким'', ''последовательным'' и ''понятным''. | # Доказательство должно быть ''чётким'', ''последовательным'' и ''понятным''. | ||
| − | # Не пишите слово «доказательство» — это уже написано в шаблоне. Не пишите «что и требовалось доказать» — для этого есть треугольничек в конце. | + | # Не пишите слово «доказательство» — это уже написано в шаблоне. Не пишите «что и требовалось доказать» — для этого уже есть треугольничек в конце. |
| + | # Если в середине доказательства встречается слово «очевидно», скорее всего, в этом переход какой-то нетривиальный и вы сами в нем не разобрались. Все проверяющие это уже давно поняли и потому лучше не привлекайте внимание к мутным местам таким идиотским способом. | ||
| − | = Алгоритмы = | + | == Алгоритмы == |
Если статья посвящена алгоритму, то её надо оформить особенным образом. Мне очень лень писать конкретные правила. Главное — в самом начале статьи должно быть чётко указано, что это за алгоритм, для чего он нужен и какова его асимптотика. Кроме того, должно быть чётко указано, что он принимает на вход, и что даёт на выходе. Пример хорошего оформления можно подсмотреть (только не смейтесь) [[Алгоритм Фарака-Колтона и Бендера|вот здесь]]. | Если статья посвящена алгоритму, то её надо оформить особенным образом. Мне очень лень писать конкретные правила. Главное — в самом начале статьи должно быть чётко указано, что это за алгоритм, для чего он нужен и какова его асимптотика. Кроме того, должно быть чётко указано, что он принимает на вход, и что даёт на выходе. Пример хорошего оформления можно подсмотреть (только не смейтесь) [[Алгоритм Фарака-Колтона и Бендера|вот здесь]]. | ||
| − | = Псевдокод = | + | == Псевдокод == |
# Используйте максимально компактный и читабельный псевдокод. Не используйте реальные языки программирования (особенно, уровня ниже средне-высокого типа Джявы или Си). | # Используйте максимально компактный и читабельный псевдокод. Не используйте реальные языки программирования (особенно, уровня ниже средне-высокого типа Джявы или Си). | ||
# Не ставьте фигурные скобки. Угадайте, для чего они нужны? Чтобы парсер языка было легче писать. Человеку они только мешают. Используйте отступы для группировки. (Питон-стайл) | # Не ставьте фигурные скобки. Угадайте, для чего они нужны? Чтобы парсер языка было легче писать. Человеку они только мешают. Используйте отступы для группировки. (Питон-стайл) | ||
Текущая версия на 23:49, 11 мая 2012
Эта статья находится в разработке!
Всё описанное здесь можно коротко выразить с помощью главного правила Студии Лебедева, состоящего из двух слов. К сожалению, я решил описать всё довольно подробно, чтобы упростить процесс сдачи-приёма статей.
Всё написанное здесь выражает мою частную позицию. Если вам повезло, и принимать статью у вас буду не я, можете не читать. Главное, чтобы тот, кто будет принимать у вас статью, не решил, что я тут пишу хорошие вещи и не стал проверять по этому моему списку. Так что советую уточнить заранее ;).
Я буду сюда дописывать что-нибудь по мере получения опыта и выявления стандартных паттернов идиотизма, так что заглядывайте иногда.
Содержание
Вообще
- Не используйте слишком много математических обозначений. Иногда текст понятнее, если его написать по-русски.
- Не лейте воду с помощью рассусоливания русских слов. Лучше напишите строгое и формальное математическое определение.
- Используйте мозг, чтобы выбрать подходящее из первых двух правил.
- Перечитайте конспект через сутки после написания. Переформулируйте все кривые фразы.
- Структурируйте статью. С умом используйте разбиение на абзацы. Не забывайте про заголовки и подзаголовки.
- Используйте шаблоны там, где это надо (для определений, теорем и т.п.).
- Ставьте ссылки на определения терминов, которые используете, но не определяете.
- Оформляйте ссылки на источники нормально.
Определения
- Не надо писать «это» после тире. Кому нужно лишнее слово, когда и так всё понятно?
Теоремы
- Доказательство должно быть чётким, последовательным и понятным.
- Не пишите слово «доказательство» — это уже написано в шаблоне. Не пишите «что и требовалось доказать» — для этого уже есть треугольничек в конце.
- Если в середине доказательства встречается слово «очевидно», скорее всего, в этом переход какой-то нетривиальный и вы сами в нем не разобрались. Все проверяющие это уже давно поняли и потому лучше не привлекайте внимание к мутным местам таким идиотским способом.
Алгоритмы
Если статья посвящена алгоритму, то её надо оформить особенным образом. Мне очень лень писать конкретные правила. Главное — в самом начале статьи должно быть чётко указано, что это за алгоритм, для чего он нужен и какова его асимптотика. Кроме того, должно быть чётко указано, что он принимает на вход, и что даёт на выходе. Пример хорошего оформления можно подсмотреть (только не смейтесь) вот здесь.
Псевдокод
- Используйте максимально компактный и читабельный псевдокод. Не используйте реальные языки программирования (особенно, уровня ниже средне-высокого типа Джявы или Си).
- Не ставьте фигурные скобки. Угадайте, для чего они нужны? Чтобы парсер языка было легче писать. Человеку они только мешают. Используйте отступы для группировки. (Питон-стайл)
- Не ставьте скобки вокруг условия if'а, while'а и т.п.. Угадайте, для чего они нужны? Правильно. (Питон-стайл)
- Обозначайте присвоение нормально, с помощью знака «=». (Кормен дурак)[1]
- Не вводите какие-то левые операторы. Например, если кладёте что-то в очередь, так и напишите: Q.push(a).
Примечания
- ↑ На странице обсуждения вот подсказывают, что в третьем издании Кормен уже не дурак.
