Участники проекта

Как стать участником проекта

В проекте есть пять ролей: автор, сопровождающий (maintainer), редактор (reviewer), ответственный редактор (editor) и выпускающий (release manager).

Автор (committer):
Участие в ADT:

Копирует документы в репозиторий исходных документов, дальше будем называть его «Куча», чтобы не путать с репозиторием Sisyphus, где размещаются готовые модули документации (см. раздел «Куча (репозиторий исходных документов)»). Взаимодействует (если хочет) с Сопровождающим по поводу своих документов.

Копируя свой документ в Кучу, Автор даёт согласие его на свободное распространение и доработку, и вместе с тем документ получает шансы на публикацию и более широкую известность.

Формат текста:

«Любой» (лучше — конвертируемый в формат разработки ADT, ещё лучше — конвертируемый в обе стороны).

Ответственность:

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

Кроме того, Автор должен отметить, согласен ли он при появлении новых версий документа копировать их в Кучу. Соглашаться необязательно (хотя и желательно). Если Автор согласился поддерживать документ в актуальном состоянии, к его обязанностям добавляется своевременное обновление документа в Куче. Автор может в любой момент отказаться от этой обязанности, сняв соответствующую отметку в описании документа.

Строго говоря, роль «Автора» не обязательно должен выполнять автор документа. Если допускают условия распространения документа, любой может его скопировать в Кучу, сопроводив соответствующим описанием.

Сопровождающий (maintainer):
Участие в ADT:

Берёт текст из Кучи и превращает его в модуль. Помещает модуль в репозиторий Sisyphus. Взаимодействует со всеми остальными персонажами.

Формат текста:

Формат разработки ADT.

Ответственность:

Содержательная (соответствие документа актуальной версии ПО, исправление ошибок и обновление документа), и формальная (требования к формату). Требования к формату возникают потому, что из модуля должен автоматически собираться HTML, пригодный для интеграции с остальными модулями.

Редактор (reviewer):
Участие в ADT:

Читает опубликованную документацию и сообщает об ошибках посредством BTS, с её же помощью взаимодействует с Сопровождающим.

Формат текста:

Формат тех публикаций или исходных текстов документации, которые ему доступны.

Ответственность:

Никакой.

Выпускающий (release manager):
Участие в ADT:

Составляет общий план выпуска документации и собирает её из модулей. Доводит формат представления до приемлемого уровня. Взаимодействует со всеми, торопит нерадивых.

Формат текста:

Форматы представления.

Ответственность:

Концептуальная (выпуск должен быть целостным по содержанию), эстетическая (и красивым).

Ответственный редактор (editor):
Участие в ADT:

Назначается Выпускающим для сплошной вычитки и правки материалов выпуска. Взаимодействует с Сопровождающими. Правки, предлагаемые ответственным редактором, имеют более высокий приоритет, чем правки обычного редактора (должны вноситься срочно). Имеет право вносить «пожарные» правки в пределах опечаток и очевидных погрешностей на стадии непосредственно перед выпуском без согласования с сопровождающими соответствующих модулей.

Формат:

Формат разработки ADT.

Ответственность:

В соответствии с тем, какая задача была перед ним поставлена выпускающим: корректура, литературная правка, содержательная правка — соответственно, отвечает за отсутствие опечаток, гладкость стиля, содержательную адекватность документов.

Роли Автора и Сопровождающего по отношению к документу может выполнять один и тот же человек; никому не возбраняется выступать в роли Редактора.

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

Всем участникам ADT стоит взаимодействовать с внешним миром и привлекать к проекту новых участников.

Как стать участником проекта

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

  • Чтобы стать сопровождающим ADT, достаточно сделать из документа, имеющегося в Куче, модуль документации и разместить его в репозитории Sisyphus. Подробнее см. раздел.

  • Чтобы стать редактором ADT, достаточно предложить правку в BTS на любой из модулей документации. Подробнее см. раздел.

  • Чтобы стать выпускающим, достаточно иметь идею, как сделать выпуск на основе материалов ADT, поддержку сообщества ADT и время на то, чтобы этим заниматься.

  • Чтобы стать ответственным редактором, достаточно, чтобы Вас на эту роль назначил выпускающий.