Altdocs

Материал из ALT Linux Wiki
Перейти к: навигация, поиск
Stub.png
Данная страница находится в разработке.
Эта страница ещё не закончена. Информация, представленная здесь, может оказаться неполной или неверной.


Пакеты документации, создаваемые ALT Docs Team[править]

Тут пока кратко будут излагаться рекомендации/правила/соглашения по пакетам документации.

Пакеты документации, создаваемые ALT Docs Team делятся на

  • модули
  • выпуски

Определение[править]

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

Выпуски представляют из себя тексты (в минимальном необходимом количестве), обильно содержащие ссылки на модули. Т.е. выпуски служат для объединения модулей.

Именование[править]

Модули как пакеты именуются следующим образом: docs-далее_всё_что_угодно Выпуски именуются следующим образом: docs-issue-далее_всё_что_угодно

Формат[править]

Для наиболее полной интеграции в систему поддерживаются несколько форматов:

  • docbook
  • html
  • m-k