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