SDB:Howto
Содержание
Ситуация
Эта статья объясняет как писать статьи для SDB (support database).
Процедура
SDB статьи пишутся чтобы помочь в решении проблем с openSUSE, а также, чтобы дать более подробное объяснение определенных вопросов. Если у вас проблемы с openSUSE, тогда SDB - это как раз место для поиска помощи.
Статьи SDB содержат:
- Ситуация
- Процедура
- Ссылки
или
- Симптомы
- Причина
- Решение
- Ссылки
Обратите внимание, что статьи SDB должны (по возможности) содержать наиболее простое решение проблемы. Однако желательно также показывать наиболее быстрое решение которое может быть достигнуто только с помощью командной строки или редактирования конфигурационных файлов. В этом случае раздел "Решение" необходимо разбить на несколько подразделов. Перед тем, как перейти к деталям, касающимся синтаксиса, вот пример статьи (Шаблон Template:SDB_article доступен когда вы создаете новую SDB статью)
Создание новой статьи
В вашем web-браузере, войдите в название новой статьи после SDB: в строке URL. Если статья не существует, или необходимо внести изменения, щелкните "edit" чтобы создать или редактировать её. Пожалуйста не переписывайте существующие статьи. В случае необходимости, добавьте число версии или "(new)" к названию.
Все статьи SDB должны начаться с SDB:, это делает поиск их легче и составляет отдельную секцию в Wiki.
Переводы
В настоящее время openSUSE wiki поддерживает многие языки. Если Вы любите, и если Вы знаете один из этих языков, пожалуйста переведите вашу статью. Если Вы не делаете, или не уверены, достаточно ли Вы быстры на иностранном языке, пожалуйста напишите электронную почту opensuse-wiki списку адресатов, и спросите кого - то, чтобы перевести вашу статью.
Если Вы перевели статью, пожалуйста добавьте связи "Interwiki" в конце статьи. Как пример, если Вы перевели статью с немецкого языка:
[[en:SDB:<articlename>]]
К английской версии, добавьте следующее:
[[de:SDB:<articlename>]]
Изменения существующих статей
Для пространства имен SDB включен механизм проверки качества статей. Если вы отредактируете статью ваши изменения будут проверены и показаны всем пользователям после проверки.
Категории
Каждая SDB статья должна быть доступна через категории. Вы можете найти нужные категории в списке доступных категорий Category:SDB. Добавьте категории в конец статьи:
[[Категория:SDB:11.4|C]] [[Категория:SDB:Сеть|C]]
При указании категории после символа вертикальной черты указывается первый символ заголовка статьи. Для примера если статья называется "Changing NTP Servers", после вертикальной черты должно следовать "C". Этот символ используется для правильной сортировки с категории.
Синтаксис
Пожалуйста прочтите наше руководство по стилю что бы понять как оформлять материалы.
Стиль
Как обращаться к читателю
В немецких SDB статьях должны использовать вежливые формы обращения с "Sie", это стандарт в технической документации. Если это относится и к вашему языку, пожалуйста, тоже используйте вежливые формы. У английских авторов, конечно таких проблем быть не должно;-).
Термины на иностранных языках
В языках отличных от английского, иногда бывает трудно обойтись без английских технических терминов. Пожалуйста пытайтесь писать так что бы ваша статья была понятна и полезна широкому кругу пользователей SDB, но не пытайтесь переводить уже устоявшиеся английские термины используемые в целевом языке. Хорошим компромиссом может быть указание обоих терминов, как в примере для немецкого : "gehen Sie auf die zweite console (Kommandozeile) mit STRG-ALT-F2"
Простота!
Даже если использовать оболочку, кажется что все легко сделать, особенно для вас. Пожалуйста подумайте о новичках в Linux, подробно объясни те им как решить проблему через YaST2 или другие инструменты.
В хорошей SDB статье описан каждый шаг. Не пишите:
В /etc/inittab, измените runlevel по умолчанию на 3.
Вместо того напишите:
Войдите как root и откройте фаил /etc/inittab с помощью вашего любимого редактора (например vi или pico). Измените строчку id:5:initdefault: на id:3:initdefault: после этого система больше не будет загружаться в графическом режиме.
Выполнить это требование не так тяжело! Помните что openSUSE используют многие новички в Linux.
Поддержка
Часто необходимо обновлять SDB статьи в связи с выходом новых версий openSUSE, или даже писать новые, если внесенные изменения слишком фундаментальны. Пожалуйста, старайтесь поддерживать свои SDB статьи. Например, если Вы заметили, что Ваша статья больше не соответствует последней версии openSUSE, пожалуйста измените строку "версия"("version").