Создание документации: различия между версиями
(Новая: == Описание процесса создания документации == === Документация в репозитории/дистрибутивах === В рамках ...) |
Нет описания правки |
||
| Строка 5: | Строка 5: | ||
В рамках проекта создаётся документация, призванная помочь пользователям в освоении Linux. | В рамках проекта создаётся документация, призванная помочь пользователям в освоении Linux. | ||
Печатная документация прилагается к | ==== Печатная документация ==== | ||
Печатная документация прилагается к дистрибутивам, выпускаемым ALT Linux. | |||
Другой вид печатной документации -- отдельные книги, учебники и т.п. | |||
==== Электронная документация ==== | |||
Электронная документация в виде rpm-пакетов присутствует в репозиториях. | Электронная документация в виде rpm-пакетов присутствует в репозиториях. | ||
Как правило, именно на основе электронная документация создаются печатные версии. | |||
Комплект электронной документации состоит из отдельных '''модулей''', которые объединены '''выпуском'''. | Комплект электронной документации состоит из отдельных '''модулей''', которые объединены '''выпуском'''. | ||
| Строка 15: | Строка 19: | ||
Выпуск не несёт в себе информативной части, а служит лишь для объединения модулей. | Выпуск не несёт в себе информативной части, а служит лишь для объединения модулей. | ||
Аналогия: | Аналогия: Файлы и Каталоги | ||
=== Форматы документации === | === Форматы документации === | ||
Электронная документация присутствует в установленной системе в виде html-файлов. Начальная страница каждого модуля содержит ссылку на '''паспорт''' модуля. Паспорт представляет из себя файл, содержащий различную мета-информацию: Автор, Версия, Тема, Краткое описание. Паспорт позволяет легче ориентироваться в большом количестве модулей. | |||
html | Модули документации создаются разработчиком в одном из поддерживаемых форматов: html, docbook, m-k. Генерация html происходит в момент моздания '''пакета'''. Этот процесс автоматизирован и описан в разделе Цикл разработки. | ||
m-k | |||
=== Цикл разработки === | === Цикл разработки === | ||
Версия от 17:13, 21 августа 2008
Описание процесса создания документации
Документация в репозитории/дистрибутивах
В рамках проекта создаётся документация, призванная помочь пользователям в освоении Linux.
Печатная документация
Печатная документация прилагается к дистрибутивам, выпускаемым ALT Linux. Другой вид печатной документации -- отдельные книги, учебники и т.п.
Электронная документация
Электронная документация в виде rpm-пакетов присутствует в репозиториях. Как правило, именно на основе электронная документация создаются печатные версии.
Комплект электронной документации состоит из отдельных модулей, которые объединены выпуском.
Модуль представляет из себя самодостаточный текст, раскрывающий в той либо иной степени определённую тему. Например модуль может описывать процесс установки дополнительного ПО.
Выпуск не несёт в себе информативной части, а служит лишь для объединения модулей.
Аналогия: Файлы и Каталоги
Форматы документации
Электронная документация присутствует в установленной системе в виде html-файлов. Начальная страница каждого модуля содержит ссылку на паспорт модуля. Паспорт представляет из себя файл, содержащий различную мета-информацию: Автор, Версия, Тема, Краткое описание. Паспорт позволяет легче ориентироваться в большом количестве модулей.
Модули документации создаются разработчиком в одном из поддерживаемых форматов: html, docbook, m-k. Генерация html происходит в момент моздания пакета. Этот процесс автоматизирован и описан в разделе Цикл разработки.
Цикл разработки
git пакет репозиторий
Инструменты документатора
git, rpm-build-docs ...