Создание документации

Материал из ALT Linux Wiki

Содержание 1 Описание процесса создания документации 1.1 Документация в репозитории/дистрибутивах 1.2 Форматы документации 1.3 Цикл разработки 1.4 Инструменты документатора

Описание процесса создания документации

Документация в репозитории/дистрибутивах

В рамках проекта создаётся документация, призванная помочь пользователям в освоении Linux.

Печатная документация прилагается к готовым дистрибутивам.

Электронная документация в виде rpm-пакетов присутствует в репозиториях.

Комплект электронной документации состоит из отдельных модулей, которые объединены выпуском.

Модуль представляет из себя самодостаточный текст, раскрывающий в той либо иной степени определённую тему. Например модуль может описывать процесс установки дополнительного ПО.

Выпуск не несёт в себе информативной части, а служит лишь для объединения модулей.

Аналогия: Фалы и Каталоги

Форматы документации

html pfd m-k

Цикл разработки

git пакет репозиторий

Инструменты документатора

git, rpm-build-docs ...