Что значат поля и категории в docinfo

Что значат поля docinfo

Title:Название документа

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

Title: Как самому собрать аппарат

Language:Язык_документа

Язык должен быть указан в виде стандартного двухбуквенного кода.Если указан язык, отличный от английского, паспорт документа должен быть в указанной ниже кодировке (соответственно языку):

Английский	en	ascii
Русский	ru	koi8-r
Украинский	uk	koi8-u

Пример:

Language: ru

Author: Автор документа

Автор документа, {Имя Фамилия}. Если у документа более одного автора, для каждого автора создаётся отдельная строка Author:. Имена авторов должны быть записаны по правилам языка документа. В скобках после имени автора можно указать его вклад в текст (перевод/редактор/составитель/etc) или имя автора в оригинальном написании (если документ переводной).
Пример:

Author: Ричард Столлман (Richard Stallman)
Author: Иван Купала (перевод)

Version:Версия документа

Необязательное поле. У некоторых (но далеко не у всех) документов есть номер версии. Для таких документов вводится необязательное поле Version:. Если авторы документа не имеют обыкновения указывать его версию при обновлении, то не нужно вводить её искусственно: при отсутствии в паспорте поля Version: обновления будут отслеживаться по дате поступления документа в репозиторий исходных текстов.
Пример:

Version: 2.718281828459045

License:Условия распространения

Поле License: может содержать одну из следующих строк:

Строка	Значение
GPL	GNU General Public License
FDL	Free Documentation License
distributable	Документ можно свободно распространять, обычно с соблюдением каких-то условий

Версии лицензий или точные условия распространения документа указываются в файле License в составе пакета, см. раздел «Оформление документа для Кучи» ALTLinuxDocsTeamPolicy.
Пример:

License: distributable

Url:URL исходного документа

Необязательное поле. Если исходный документ изначально опубликован где-то в Интернет и поддерживается (обновляется) там, в этом поле следует указать соответствующий URL.
Пример:

Url: http://docs.altlinux.ru/admin/pt01.html

Format:Формат документа

Формат, в котором представлен документ (plain text, html, DocBook/XML и т. д.). Если документ представлен в нескольких форматах, нужно сделать отдельное поле Format: для каждого формата.
Пример:

Format: plain text
Format: html

Abstract: Аннотация

Краткая (в один абзац) аннотация к документу, из которой должно быть понятно, о чём он, в чём его специфика и какова ценность. В аннотации не должно быть переводов строки (т. е. набирать всё в одну строку).
Пример:

Abstract: Полное руководство по самостоятельной сборке и отладке аппарата с примерами, таблицами истинности и выдержками из интернет-рекаламы

Supported: yes/no

Является ли документ поддерживаемым, т. е. будет ли Автор (committer) отвечать на предложения и вопросы по тексту, направленные участниками ATD.
Пример:

Supported: yes

Updated: yes/no

Является ли документ обновляемым, т. е. будет ли Автор (committer) отправлять в Кучу новый архив по мере появления новой версии документа.
Пример:

Updated: yes

Section: Категория документа

Список категорий фиксированный (см. ниже). Нужно использовать все категории, под которые подходит документ. Категории разбиты на 5 разделов. Желательно, чтобы в каждом разделе была использована хотя бы одна категория (иначе по этому разделу получится значение «Прочее»). Если поля Section: нет вообще, паспорт считается некорректным.
Пример:

Section: Научно-популярный
Section: Инструкция
Section: Персональное
Section: Аппаратное обеспечение
Section: Многоплатформенный

Что значат категории docinfo

• Уровень изложения

  Section: Научно-популярный

  Документ может читать кто угодно. Если не всё поймёт, то, по крайней мере, получит удовольствие

  Section: Пользовательский

  Документ рекомендуется к прочтению пользователю, имеющему интерес и некоторые знания в предметной области; все «хитрости» автор постарается объяснить

  Section: Профессиональный

  Документ предназначен для профессионала, разъяснений «очевидных» и «всем известных» вещей не предполагается

• Тип документа

  Section: Инструкция

  Документы в стиле «Как», предназначенные для оперативного или неквалифицированного снятия проблем (без объяснений или с объяснением, куда пойти и что почитать).

  • тренинг и справочники в стиле «проблема — решение» (например, руководство оператора или секретарши);
  • разовые или пошаговые действия (напр., руководство по установке);
  • оперативные ответы на вопросы (HOWTO);
  • памятки, шпаргалки, сводные таблицы и т. п.

  Section: Документация

  Документы в стиле «Как и Почему» (порядок любой, но и то, и другое должно наличествовать), предназначенные для того, чтобы раз и навсегда объяснить читателю, в чём дело, и чтобы он глупых вопросов больше не задавал.

  • методички (это близко к «Как», но пользователь должен уйти с чувством, что всё понял);
  • примеры решения хитрых или, наоборот, типовых задач хитрыми инструментами (нечто среднее между предыдущим и следующим пунктом);
  • ответы на вопросы «Почему»;
  • учебники...

  Section: Декларация

  Документ в стиле «Why» или «What», то есть описывающий что-то без цели научить, разве только поставить в известность или убедить.

  • полиси и правила;
  • форматы;
  • реклама, демонстрации, презентации;
  • гуманитарные тексты о разработке ПО и компьютерах: сообщество, феномен свободного ПО, экономические и правовые модели и т. п.
  • всяческие манифесты, лицензии, общественные договоры...

• Тип решения
  Решение — это способ так написать / поставить / настроить программное обеспечение, чтобы пользователю(лям) было удобно что-то делать (решать свои прикладные задачи). Многие документы описывают именно решения, т. е. как данную задачу решить с помощью ПО. Ниже предложена классификация по типам задач, и, соответственно, решений.

  Section: Персональное

  То, что делается «для себя». Сюда относится организация рабочего места, маленькие хитрости, игры и т. п.

  Section: Сервисное

  То, что делается «для фирмы». Сюда относятся всяческие административные дела: организация серверов, корпоративной сети и т. п.

  Section: Общественное

  То, что делается «для сообщества» и сообществом. Сюда относятся всяческие полиси, манифесты, инструменты совместной разработки и т. п.

• Тип объекта (тема документа)

  Section: Тексты и гипертексты

  Объекты, которые читают: документы, www, news и т. п.

  Section: Мультимедиа

  Объекты, которые воспринимают любым другим способом: нюхают, лижут, слушают, любуются и т. п.

  Section: Программы

  Объекты, которые сами работают: программирование, серверы приложений

  Section: Хранение и переработка данных

  Прочие неклассифицированные объекты: базы данных, в основном.

  Section: Бизнес

  Компьютер как средство организации труда.

  Section: Сеть

  Объекты передаются по сети.

  Section: Обслуживание и безопасность

  Объект — сам компьютер!

  Section: Аппаратное обеспечение

  Компьютер — это куча металлолома!

• Специфичность

  Section: ALT

  В документе содержатся сведения, специфичные для проектов ALT.

  Section: UNIX/POSIX

  В документе содержатся сведения, специфичные для UNIX-совместимых систем (стандарт POSIX). Linux сюда относится.

  Section: Многоплатформенный

  Документ описывает многоплатформенные ПО и решения.