SliTaz Repositories

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/pages/ru/guidelines.txt	Thu Sep 15 06:36:20 2011 +0000
     1.3 @@ -0,0 +1,88 @@
     1.4 +====== Принципы ведения документации SliTaz =====
     1.5 +Этот документ содержит рекомендации по написанию статей вики и задачи, которые должны быть выполнены, чтобы сделать документацию SliTaz актуальной.
     1.6 +
     1.7 +
     1.8 +===== Пересмотр документации =====
     1.9 +  - Централизация всей документации на [[http://doc.slitaz.org]]
    1.10 +  - Полная миграция «Настольной книги» и «Поваренной книги» (и «SliTaz с самого начала», если это возможно)
    1.11 +  - Перевод «Настольной книги» и «Поваренной книги»
    1.12 +  - Связывание ссылками или перевод статей вики на [[http://labs.slitaz.org|веб-сайте лабораторий]]
    1.13 +  - Пересмотр и обновление «Настольной книги» и «Поваренной книги» к версии 3.0
    1.14 +  - Добавление новых руководств. Лист пожеланий по руководствам находится на [[http://doc.slitaz.org/en:guides:start|странице руководств]] в качестве отправной ссылки
    1.15 +  - Пересмотр и обновление существующих руководств
    1.16 +
    1.17 +
    1.18 +===== Общие указания =====
    1.19 +  * **Добавляйте**: Не стесняйтесь добавлять любые страницы в вики
    1.20 +    * __Пространства имен или структура документации__: Структура документации была определена для английского языка. Придерживайтесь ее в качестве стандарта при создании страниц. Несколько примеров:
    1.21 +      * //en:handbook:start//: Начальная страница «Настольной книги»
    1.22 +      * //en:handbook:desktop//: Desktop — это ссылка на страницу с начальной страницы «Настольной книги». Все страницы «Настольной книги» должны находиться в пространстве имен "en:handbook:"
    1.23 +      * //en:guides:faq//: Все страницы руководств должны находиться в пространстве имен "en:guides". Чтобы создать страницу ЧаВо (Часто задаваемых Вопросов), просто создайте ссылку <nowiki>[[faq | ЧаВо]]</nowiki>. Это автоматически создаст страницу ЧаВо в нужном пространстве имен en:guides:faq
    1.24 +      * //Index//: Ссылки могут быть использованы для просмотра структуры документации
    1.25 +    * __Добавляйте изображения__: Используйте панель инструментов для добавления изображений с соответствующее пространство имен
    1.26 +  * **Удаляйте**: Просто удалите всё содержимое страницы для того, чтобы удалить страницу
    1.27 +  * **Обзор**: Каждая страница должна содержать раздел обзора. К примеру, [[#форматирование|внизу этой страницы]]. Раздел обзора — это просто таблица вики. Вы вольны изменять эту таблицу и/или добавлять в нее дополнительные строки. Вы можете перевести ее на свой родной язык. Также вы можете скопировать эту таблицу с данной страницы и вставить ее на любую другую страницу вики, соответственно отредактировав
    1.28 +
    1.29 +
    1.30 +===== Шаблон страницы =====
    1.31 +
    1.32 +Существует несколько определенных стилей страниц, в которые мы можем поместить содержимое. 
    1.33 +
    1.34 +
    1.35 +=== ЧаВо ===
    1.36 +
    1.37 +Следующее относится к одной странице, [[en:guides:faq|Frequently Asked Questions]].
    1.38 +
    1.39 +  - **Сообщения об ошибках** — озаглавьте каждый вопрос-ответ наиболее подходящим описанием, обычно отображаемым сообщением об ошибке.
    1.40 +  - **Симптомы** — короткое описание, что пользователь может получить при применении этого ЧаВо. Их может быть более одного. Используйте правильное форматирование при описании экранных сообщений, сочетаний клавиш и т.п. Надеемся, что поиск Google приведет пользователей именно сюда.
    1.41 +  - **Объяснение** — не слишком техническое описание сообщения об ошибке. Пользователи смогут понять проблему и то, как ее можно решить в лучшем виде.
    1.42 +  - **Решения** — как решить проблему технически. Включая краткие описания необходимых шагов, а не просто список команд; это важно для понимания того, что пользователь должен сделать. Если различные проблемы имеют слегка разные решения — применяйте для их организации списки.
    1.43 +
    1.44 +
    1.45 +=== Обзоры ===
    1.46 +
    1.47 +Они находятся в пространстве имен <язык>:guides:<тема>. Они описывают процесс, как заставить что-либо работать.
    1.48 +
    1.49 +  - **Введение** — Summarize the article  
    1.50 +  - **Графически** 
    1.51 +     * Инструкции — How to use the graphical tool (if it exists) 
    1.52 +     * Снимки экрана — Картинка лучше, чем тысяча слов
    1.53 +  - **Вручную**
    1.54 +     * Установка — Define the packages required and how to install them 
    1.55 +     * Настройка — Explain how to configure files for the proper functioning of packages 
    1.56 +     * Summarize — If possible, summarize all commands in one single script for troubleshooting
    1.57 +  - **Примеры и подсказки** — Add some examples and advanced tips
    1.58 +  - **FAQ/Troubleshooting** — Some DIY instructions or a sub-section on problems/symptoms/solutions/notes or a link to forum posts. Link to FAQ if answered there
    1.59 +  - **References** — Other good reference material on the Internet. If there aren't any, consider a message asking for some!
    1.60 +
    1.61 +
    1.62 +=== «Настольная книга» ===
    1.63 +
    1.64 +These reside under the <lang>:handbook:<topic> namespace. They brief the reader on what SliTaz can offer on a particular topic. They are an overview and description and not a guide, though they may contain (very) few steps on how to get up-and-running.
    1.65 +
    1.66 +  - **Blurb** — describes the content of the page, in terms of scope.
    1.67 +  - **Topic** — what the user expects to achieve, e.g. 'Image Processing' or 'Desktop Themes'
    1.68 +  - **Body Text** — an overview of the topic, with links to relevent Guides or external web pages.
    1.69 +  - **Tips** (optional) — any problems the user may experience. Link to FAQ if answered, forum posts, good problem-solving web pages etc.
    1.70 +
    1.71 +
    1.72 +===== Форматирование =====
    1.73 +
    1.74 +Используйте правильное форматирование везде, где это возможно. Это улучшит читабельность и исправит непонимание, где вводимые команды, а где их вывод, и т.п.
    1.75 +
    1.76 +  * Изучайте синтаксис вики [[http://doc.slitaz.org/wiki:syntax?s[]=playground | здесь]]. Для опробования новых знаний синтаксиса просто используйте специальную страницу — [[http://doc.slitaz.org/en:guides:playground| песочница]]
    1.77 +
    1.78 +----
    1.79 +
    1.80 +^  Раздел обзора страницы  ^^ 
    1.81 +|Качество| хорошее  |
    1.82 +|Обзор| должно быть просмотрено |
    1.83 +|Приоритет| средний |
    1.84 +|Проблемы| добавить [[http://forum.slitaz.org|ссылку на форуме]]|
    1.85 +|:::     | ИЛИ добавить [[http://labs.slitaz.org/issues|ссылку в трекере неисправностей лабораторий]]|
    1.86 +|Как улучшить| предлагайте кратко, например,|
    1.87 +|::: |  [[http://labs.slitaz.org/wiki/packages|Здесь находятся новые руководства по тестированию пакетов]]  |
    1.88 +|::: | Добавляйте новые строки, такие, как эта ;-)  |
    1.89 +
    1.90 +\\
    1.91 +----
    1.92 \ No newline at end of file