Форумно oбявление: [ ! ] Препоръчително правило за писане на Ръководство.
1. На какви програми да се правят ръководства?

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

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

2. Съдържание и стил

Независимо дали пишете практическо ръководство за дадена програма (как да се извършат конкретни действия с нея) или пишете по-скоро описание на програмата и разяснявате опциите й, всичко е редно да бъде обяснено на достъпен и лесен за асимилиране език. Не бива да е на твърде висок стил, защото по-неопитните потребители ще изпитват затруднения при четенето, но не бива и да е прекалено елементарно, защото може да е изнервящо, а и не се научават нови неща. При напипването на златната среда се получава материал, в който все пак има терминология, но е поднесена така, че потребителят хем разбира материала, хем научава нещо ново и обогатява знанията си, а именно това е целта ни.

- В началото на материала включете информация за програмата: официална страница, лиценз, размер и някоя друга характерна особеност ако сметнете за необходимо.

- Напишете нещо за увод. Опишете с няколко изречения за какво е програмата, какво ще се опише в ръководството и всяка друга информация, която да спомогне четящият потребител да премине плавно към същината.

- Драснете и нещо и за заключение. Цяло ръководство сте написали, за някой-друг ред заключение ли ще се скръндзите. Придава на материала завършен и стегнат вид.

- Въздържайте се от използването на транскриптирани чужди думи като "сейвам", "лоуднете", "едитвам" и др. По-опитния потребител ще се ориентира, но за по-начинаещите, такива думи действат объркващо. Освен това и звучат глупаво. Използвайте българските преводи като "запазвам", "заредете", "редактирам".

- Не бъдете лаконични, обяснявайте по-подробно, особено неща, които сметнете за тънкост.

- Можете да ползвате помощни средства, но избягвайте да предоставяте само един превод на помощния файл, освен ако той не е наистина изчерпателен и добре обяснен. Просто включената в помощния файл информация не винаги е достатъчна и ръководството ще е непълно. И все пак...

- ...ако смятате, че помощния файл е достатъчно изчерпателен и решите да го преведете (или превеждате готова информация отнякъде), укажете това в ръководството и споделете източника.
Редно е да се знае откъде е взет текста, който сте превеждали/ползвали, а и няма нищо срамно да се преведе вече готов текст. Това също си е труд.

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

- Избягвайте използването на емотикони. Не пречи да има някоя-друга, но все пак пишете ръководство, а не фейлетон.


3. Оформяне на текста и изглед


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

- Старайте се да пишете правилно и грамотно. Всеки материал ще бъде преглеждан за правописни, пунктуационни и други подобни "козметични" грешки, които ще бъдат коригирани, но това все пак не пречи да се стараете при писането.

- За основен текст на материала използвайте стандартния размер и цвят. Не пишете материала си изцяло в удебелен шрифт или в някакъв цвят. Същото важи и за размера на буквите - използвайте го само, когато е нужно.

- Когато ползвате картинки и са доста големи, е желателно да ги оразмерявате за да не излизат извън пределите на екрана и да развалят структурата на текста.

- Когато давате дълги линкове, по-прегледно е да са в следния вид: тема, а не http://www.stotinkaos.net/forums/index.php

- Не пишете "незнам", а "не знам". "Не" е отделна дума.

- Избягвайте съкращения. Не заменяйте един/една/едно с "1". Избягвайте да използвате "в/у" за "върху" , "м/у" за "между" и др. Съкращения като "т.н.", "др." не се броят.

4. Програми за създаване на изображения/хостинг на изображения.


- Можете да използвате следните програми за правене на изображения на десктопа: Gnome Screenshot, KSnapshot, Scrot, Xfce4 Screenshooter.

- Ако имате нужда да качвате картинки някъде, това може да стане на отделни хостове, пример за това са: http://imageshack.us/ http://picbg.net http://pics.data.bg/

5. Примери за лоши и добри ръководства.

Пример за това са:

- Добре написано ръководство: http://www.stotinkaos.net/forums/thread-115.html

- Лошо написано ръководство: http://www.stotinkaos.net/forums/thread-129.html


Затова, всички ние от екипа на sOS, се обръщаме с молба към всички потребители, които
вече са написали някакво/и ръководство/а, да ги прегледат отново, и ако имат възможност да ги редактират спрямо горе изложеното. Благодарим още веднъж на всички които помогнаха, и продължават да помагат, този проект да съществува. Благодарности на всички потребители!