Правила оформления статей

Хочется (а может быть, правильнее сказать «надо»?), чтобы статьи выглядели единообразно. И чтобы наша имхотека всё-таки напоминала энциклопедию, а не набор черновиков, выполненных то ручкой Parker, то карандашом на обоях, то губной помадой на зеркале, а то и вовсе кровью врага на штукатурке.
Попробуем сформулировать, как будет лучше.

Ссылка

Написание новой статьи начинается со ссылки в адресной строке. Как только вы по ней перейдете, движок подскажет, что такой статьи еще нет и вы можете ее создать.
Не спешите!
Прежде чем переходить, тщательно проверьте, лучше раз пять, что вы написали в адресной строке. С момента создания это станет адресом статьи навсегда и ошибки здесь уже никто не исправит. Единственный способ исправления — удалить статью и создать ее заново, уже с новым адресом. Других способов, увы, нет1).

Если ссылка состоит из нескольких слов, разделяйте их дефисом. Движок поймет и пробел, и в меру сил сам его заменит, но… «Старайся делать хорошо. Плохо само получится».

Заголовки

Если первая строка — не заголовок h1, то это безобразие, и его необходимо исправить, чем быстрее, тем лучше. Идеально — еще до первого сохранения статьи. Именно этот заголовок станет ее названием в меню, в тайтле страницы и далее везде.

Выбор заголовка

Если заголовок всей статьи h1, то по логике HTML следующий заголовок, открывающий какой-то раздел статьи, будет h2. И так далее — чем глубже в иерархию, тем больше номер и мельче заголовок. Поэтому не перескакивайте с h1 сразу на h4. Стройте иерархию в соответствии со смыслом.

Форматирование текста

Все всё знают, всем надоело это читать. Но 75% продолжают повсеместно писать как попало, демонстрируя полное и безоговорочное неуважение к читателю. Поэтому снова о надоевшем.

  • Разбивайте текст на абзацы, так его удобнее читать. Вам трудно дважды нажать Enter?
  • Если вы не уверены, что хорошо помните приемы форматирования — откройте в соседней вкладке шпаргалку. Не стесняйтесь, не на экзамене.
  • Если между двумя словами стоит знак препинания, пробел перед ним недопустим, а после него необходим. Тире — исключение, оно обрамляется пробелами с обеих сторон. Открывающая скобка — второе исключение, пробел нужен перед ней, а не после.
  • Дефис и тире — разные знаки. И два (три) дефиса подряд — это проще, чем Alt+0150 (Alt+0151).

Орфография и пунктуация

В нашем коллективе имеется ряд злобных грамматических шовинистов, преисполненных любви к Великому, Могучему, Правдивому и Свободному (и лютой ненависти к его осквернителям). Если что не так, они непременно подправят, уж в этом можете не сомневаться. Но конечно же, будут ворчать, что их чувство прекрасного оскорблено, и что автора не мешало бы посадить на два года2). Постарайтесь не раздражать их по пустякам. Но если вы не в силах — это не смертельно. Больше того, в глубине души они даже рады подредактировать статью и истребить ошибки во имя чистоты Великого и Могучего. В пределах разумного, конечно.

Лексика и стилистика

Официальный язык имхотеки — русский литературный. Отклонения от этого фундаментального правила допустимы — в рамках разумного и уместного. Чувство юмора — это прекрасно, важно, нужно, но не стоит забывать, что одно Луркоморье уже есть, а второе никому не требуется. К тому же, вторых не бывает.

Иногда из песни слов не выкинешь… но на самом деле это бывает не так уж часто. :-)

Косноязычие — тяжкий грех. Пишите так, чтобы вас поняли правильно, а не истолковали в меру сил. Время от времени нажимайте кнопку «Просмотр» и пытайтесь ответить на классический вопрос: «А сам-то понял, что сказал?».

И наконец, о главном

То есть, о содержании. ИМХОтека — сборник наших знаний и мнений. И если уж вы беретесь выражать свое мнение на виду у всей Мировой Паутины, то выражайте во всей полноте, развернуто и подробно. Мнениям вроде «Яндекс — редиска, Платон — бездельник!» место не здесь, а на заборе. Или в Твиттере3). А здесь — будьте любезны написать статью, а не «три буквы кистью».

Поскольку здесь собираются вместе знания и мнения, важно их не путать. Когда у вас нет точной информации, не стесняйтесь писать «вероятно», «предположительно», и прочие вводные обороты, которые покажут границу между «точно знаю» и «нутром чую, но обосновать не могу».

Указание источника информации — правило хорошего тона. В отличие от Википедии, здесь не пристают с требованиями доказать авторитетность источников и обвешать ссылками на них каждый абзац. Об авторитетности источников (а также выводов и мнений) пусть судит читатель, это его право. Но дайте ему возможность судить.

1) На самом деле, конечно, они есть, но править имена файлов в виде URL-кодированного текста в utf8, а потом переписывать эти же шестнадцатиричные каракули еще в нескольких местах — это уже слишком. Во много раз проще удалить и создать заново.
2) Разумеется, посадить за парту, на которой будут лежать классические труды Бархударова и Крючкова. А вы что подумали?
3) Разница между забором и Твиттером совсем не так велика, как кажется. В обоих случаях развернутые сообщения неуместны, да и всерьез их никто воспринимать не будет.
wiki/оформление-статей.txt · создано: 2012/09/22 17:51 — Spinne · Последние изменения: 2012/10/09 02:55 — Spinne
Наверх
Driven by DokuWiki