slitaz-doc-wiki-data view pages/ru/guidelines.txt @ rev 2
Add pages/ru folder.
| author | Christopher Rogers <slaxemulator@gmail.com> |
|---|---|
| date | Sat Feb 26 12:11:48 2011 +0000 (2011-02-26) |
| parents | |
| children |
line source
1 ====== Принципы ведения документации SliTaz =====
2 Этот документ содержит рекомендации по написанию статей вики и задачи, которые должны быть выполнены, чтобы сделать документацию SliTaz актуальной.
5 ===== Пересмотр документации =====
6 - Централизация всей документации на [[http://doc.slitaz.org]]
7 - Полная миграция «Настольной книги» и «Поваренной книги» (и «SliTaz с самого начала», если это возможно)
8 - Перевод «Настольной книги» и «Поваренной книги»
9 - Связывание ссылками или перевод статей вики на [[http://labs.slitaz.org|веб-сайте лабораторий]]
10 - Пересмотр и обновление «Настольной книги» и «Поваренной книги» к версии 3.0
11 - Добавление новых руководств. Лист пожеланий по руководствам находится на [[http://doc.slitaz.org/en:guides:start|странице руководств]] в качестве отправной ссылки
12 - Пересмотр и обновление существующих руководств
15 ===== Общие указания =====
16 * **Добавляйте**: Не стесняйтесь добавлять любые страницы в вики
17 * __Пространства имен или структура документации__: Структура документации была определена для английского языка. Придерживайтесь ее в качестве стандарта при создании страниц. Несколько примеров:
18 * //en:handbook:start//: Начальная страница «Настольной книги»
19 * //en:handbook:desktop//: Desktop — это ссылка на страницу с начальной страницы «Настольной книги». Все страницы «Настольной книги» должны находиться в пространстве имен "en:handbook:"
20 * //en:guides:faq//: Все страницы руководств должны находиться в пространстве имен "en:guides". Чтобы создать страницу ЧаВо (Часто задаваемых Вопросов), просто создайте ссылку <nowiki>[[faq | ЧаВо]]</nowiki>. Это автоматически создаст страницу ЧаВо в нужном пространстве имен en:guides:faq
21 * //Index//: Ссылки могут быть использованы для просмотра структуры документации
22 * __Добавляйте изображения__: Используйте панель инструментов для добавления изображений с соответствующее пространство имен
23 * **Удаляйте**: Просто удалите всё содержимое страницы для того, чтобы удалить страницу
24 * **Обзор**: Каждая страница должна содержать раздел обзора. К примеру, [[#форматирование|внизу этой страницы]]. Раздел обзора — это просто таблица вики. Вы вольны изменять эту таблицу и/или добавлять в нее дополнительные строки. Вы можете перевести ее на свой родной язык. Также вы можете скопировать эту таблицу с данной страницы и вставить ее на любую другую страницу вики, соответственно отредактировав
27 ===== Шаблон страницы =====
29 Существует несколько определенных стилей страниц, в которые мы можем поместить содержимое.
32 === ЧаВо ===
34 Следующее относится к одной странице, [[en:guides:faq|Frequently Asked Questions]].
36 - **Сообщения об ошибках** — озаглавьте каждый вопрос-ответ наиболее подходящим описанием, обычно отображаемым сообщением об ошибке.
37 - **Симптомы** — короткое описание, что пользователь может получить при применении этого ЧаВо. Их может быть более одного. Используйте правильное форматирование при описании экранных сообщений, сочетаний клавиш и т.п. Надеемся, что поиск Google приведет пользователей именно сюда.
38 - **Объяснение** — не слишком техническое описание сообщения об ошибке. Пользователи смогут понять проблему и то, как ее можно решить в лучшем виде.
39 - **Решения** — как решить проблему технически. Включая краткие описания необходимых шагов, а не просто список команд; это важно для понимания того, что пользователь должен сделать. Если различные проблемы имеют слегка разные решения — применяйте для их организации списки.
42 === Обзоры ===
44 Они находятся в пространстве имен <язык>:guides:<тема>. Они описывают процесс, как заставить что-либо работать.
46 - **Введение** — Summarize the article
47 - **Графически**
48 * Инструкции — How to use the graphical tool (if it exists)
49 * Снимки экрана — Картинка лучше, чем тысяча слов
50 - **Вручную**
51 * Установка — Define the packages required and how to install them
52 * Настройка — Explain how to configure files for the proper functioning of packages
53 * Summarize — If possible, summarize all commands in one single script for troubleshooting
54 - **Примеры и подсказки** — Add some examples and advanced tips
55 - **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
56 - **References** — Other good reference material on the Internet. If there aren't any, consider a message asking for some!
59 === «Настольная книга» ===
61 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.
63 - **Blurb** — describes the content of the page, in terms of scope.
64 - **Topic** — what the user expects to achieve, e.g. 'Image Processing' or 'Desktop Themes'
65 - **Body Text** — an overview of the topic, with links to relevent Guides or external web pages.
66 - **Tips** (optional) — any problems the user may experience. Link to FAQ if answered, forum posts, good problem-solving web pages etc.
69 ===== Форматирование =====
71 Используйте правильное форматирование везде, где это возможно. Это улучшит читабельность и исправит непонимание, где вводимые команды, а где их вывод, и т.п.
73 * Изучайте синтаксис вики [[http://doc.slitaz.org/wiki:syntax?s[]=playground | здесь]]. Для опробования новых знаний синтаксиса просто используйте специальную страницу — [[http://doc.slitaz.org/en:guides:playground| песочница]]
75 ----
77 ^ Раздел обзора страницы ^^
78 |Качество| хорошее |
79 |Обзор| должно быть просмотрено |
80 |Приоритет| средний |
81 |Проблемы| добавить [[http://forum.slitaz.org|ссылку на форуме]]|
82 |::: | ИЛИ добавить [[http://labs.slitaz.org/issues|ссылку в трекере неисправностей лабораторий]]|
83 |Как улучшить| предлагайте кратко, например,|
84 |::: | [[http://labs.slitaz.org/wiki/packages|Здесь находятся новые руководства по тестированию пакетов]] |
85 |::: | Добавляйте новые строки, такие, как эта ;-) |
87 \\
88 ----