SDB:FAQ
Эта статья расскажет о разнице между SDB, Howto и FAQ.
SDB
База поддержки уже используется очень давно как инструмент помощи пользователям openSUSE. Чтобы сохранить порядок в SDB, должны соблюдаться следующие правила:
- Это реагирование. Если с предметом статьи нет проблем, то и статья SDB не нужна. Но это не должно вас останавливать от написания статьи где нибудь за пределами SDB.
- Это точное попадание. Описывайте все подробно, но помните что пользователи хотят быстрое решение. Если есть больше информации, создайте на нее ссылку.
- Это простота. Если есть несколько способов решить проблему, используете самый простой. Так же можно указать более продвинутый способ в качестве дополнения. Например терминал против YaST.
- Это об openSUSE. Для решения проблемы используйте инструменты openSUSE, установленные у всех по умолчанию. Emacs мощный редактор, но он не устанавливается по умолчанию.
- SDB не место для творчества в дизайне страниц, пожалуйста прочтите Руководство по SDB
- Используйте пространство имен SDB: и адекватные SDB категории.
Howto
Из определения wikipedia: "How-to (howto) — английское выражение (англ. how to — как сделать), получившее распространение во многих языках, которым называют набор инструкций (часто кратких и неформальных) для выполнения каких-либо задач."
Howto дает вам больше свободы по сравнению с SDB. В общем вы можете забыть все правила SDB или их трансформировать:
- Это инициатива. В HOWTO описывается что-то новое, то что мы хотим сделать с нашей openSUSE, оно не описывает как исправить имеющиеся проблемы, как SDB.
- Будьте более подробны, объясняйте для чего что-то делается, если хотите.
- Нелегкие правила. Помните, если вы описали вещи легко, вы скорей всего поможете большему количеству пользователей.
- Добавьте статью в Категория:SDB:HOWTOs.
FAQ
Из определения wikipedia: "FAQ, F.A.Q. (акроним от англ. Frequently Asked Question(s) — часто задаваемые вопросы — собрание часто задаваемых вопросов по какой-либо теме и ответов на них."
- Сделайте это коротким.
- Думайте об этом, как о действительно часто задаваемых вопросах
- Не размещайте FAQ в других местах, лучше сделайте ссылку на отдельное FAQ.
- Используйте пространство имен FAQ:
Разное
Если вы не уверены к какой категории относится ваш документ:
- Спросите в рассылке opensuse-translation-ru(русский), opensuse-wiki(английский).
- Напишите без указания пространства имен (страничка при необходимости может быть перенесена).
- Не пугайтесь этих правил просто пишите.
- Люди в openSUSE очень дружелюбны.
- Если статья перенесена или исправлена, то это сделано из самых добрых побуждений.
- Если вы с чем-то не согласны, вы всегда можете обсудить это с другими редакторами на странице обсуждения.
