Формат

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

Реших да напиша някакви указания за единен стил на статиите, защото нищо не казва "липса на координация" като две поредни статии, които изглеждат коренно различно и съответно объркващо.
Добра цел за едно уики е да създаде лесна за ориентиране среда, затова е по-хубаво да имаме ясно определени критерии за постигането на тази цел.
Затова сега ще формулирам няколко принципа за писане на статии, които според мен би трябвало всички да се стараем да спазваме. Това е един вид манифест на уикито.

Цел

Основна цел на всеки текст в уикито е да предава информация, да обучава.
Това е най-важното нещо. Виждал съм страхотни проекти, които са провалени от желанието на авторите им да се обезсмъртят чрез творбите си.

  • Истинският кунг-фу майстор не е този, който знае всички бойни стилове, а този, който може ти нарита задника само с нокътя на малкия пръст на крака си. Добра идея е текстовете да не са прекалено дълги.
  • Всичко трябва да бъде възможно най-просто за разбиране и усложнения трябва да се допускат само когато е неизбежно. Формулите илюстрират текста, а не обратното. Формула или сорс-код без текст не спомагат за научаването на темата.
  • Ако твоята статия бъде променена след като си я написал, не го приемай лично. Някой е решил, че нещо може да бъде по-добре. Не пишем статиите за да задоволим егото си. Не се и заяждайте за глупости в нечия чужда статия.

Единен стил

Всички страници трябва да спазват единен критерий за оформяне на информацията.
Ако човек просто търси определена теорема/формула, най-добре бързо да намери каквото му трябва. Най-общо казано визуалният стил трябва да напомня на wikipedia.

  • Пише се на кирилица. За въвеждане на формули използвайте [[math]] тага.
  • Съкращавайте само наистина очевидните неща.
  • Теореми, дефиниции и като цяло всяко нещо, което трябва да бъде запомнено едно-към-едно от урока, са подчертани, удебелени, наклонени или каквото ти дойде на ум. Т.е. надписът "Теорема:" е подчертан, не самото твърдение, все пак :).
  • Първото срещане на някакъв термин, т.е. моментът в който казваме "тази формула се нарича формула на Коши", се слага в курсив(italic).
  • Важни неща за разбирането на теорията се слагат удебелени(bold). Не прекалявайте, моля.
  • Разделите се слагат в Heading 2, подразделите в Heading 3. След всяко заглавие има хоризонтална черта.
  • Добре е всяка страница да има съдържание. Това се прави с [[toc]] тага.
  • Някои неща е по-добре да не бъдат показвани веднага. Решенията на задачите за упражнение и алтернативни доказателства на теореми са два бързи примера. Такива неща е най-добре да се слагат в следния таг:
  • Ако има задачи за упражнение, то те трябва да са отделени по някакъв начин (например сложени в края на статията в отделен подраздел?)
  • Ако някъде се колебаеш дали да сложиш нов ред или не - сложи, безплатни са.

Тон

Цялостният тон на сайта трябва да не е натоварващ.
Идеята е това да бъде дружелюбно място, където всеки да може да научи каквото му трябва.

  • Не обиждайте читателите си ("Това е толкова тъпо, че само пълен тъпак би бил достатъчно тъп, за да не го разбере веднага").
  • Неакадемичен стил на писане е приемлив, стига в крайна сметка да предава нужната информация без твърде много страничен шум.
  • В момента сайтът е настроен максимално либерално и всеки има големи права. Това ще продължи да бъде така, докато не пречи на функционирането му. Моля, не бъдете деструктивни.
  • Ако някой иска да пише за предмет различен от задължително изучаваните - няма никакъв проблем.

В заключение

Тези правила, както всяко нещо в уикито, подлежат на промяна. Ако някой мисли, че има нещо да каже по въпроса, нека пише във форума или като лично съобщение, и ще го обсъдим.

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License