[docs] ALT Docs Team policy. Part 0.

[Kirill Maslinsky]

Всем добрый день!

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


-- 
Kirill Maslinsky
ALT Linux Team * Documentation Project   
-------------- next part --------------
#Версия документа: 0.0.1

0. Задачи проекта
=================

ALT Linux Docs Team (в дальнейшем ADT) -- открытый
общественный проект, ставящий своей целью создание и
поддержание в актуальном состоянии свободной документации по
программам репозитория Sysiphus и решениям на его основе.
Под решениями понимаются способы применения компонентов Sisyphus
для решения прикладных задач пользователей.

В рамках проекта предполагается решение следующих задач:

* Мониторинг потребностей в свободной документации.

* Улучшение имеющихся и создание новых документов,
поддержание репозитория свободных документов.

* Адаптация имеющихся и создание новых инструментов для
поддержания полного жизненного цикла репозитория документации.

* Публикация репозитория свободной документации в режиме онлайн
на сайте docs.altlinux.ru, а также в виде пакетов в Sisyphus и
немедленное обнародование всех изменений и дополнений в
репозитории.

* Взаимодействие с работающими под свободными лицензиями
техническими писателями и нахождение новых участников
проекта, организация взаимодействия между техническими
писателями и свободными разработчиками.

* Взаимодействие с существующими учебными и методическими
организациями, заинтересованными в наличии свободной
документации.

* Выпуск регулярного периодического издания.


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

В проекте есть четыре роли: автор, сопровождающий (maintainer),
выпускающий (release manager) и редактор, не обязательно являющийся 
членом ALT Docs Team (reviewer). 

Автор:

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

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

	Участие в ADT: 

	Копирует тексты в репозиторий исходных текстов документации(?ссылка)
	(``кучу''), взаимодействует (если хочет) с сопровождающим по поводу
	своих текстов.

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

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

Сопровождающий:
        
	Формат текста: 
	
	Формат разработки ADT.

	Участие в ADT: 
	
	Берёт текст из репозитория исходных текстов (``кучи'') и 
	превращает его в модуль(?ссылка). Помещает модуль в репозиторий
	готовой документации(?ссылка). Взаимодействует со всеми 
	остальными персонажами.

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

Редактор:

        Формат текста: 
	
	Какой увидит.
	
        Участие в ADT: 
	
	Читает опубликованную документацию и сообщает об ошибках 
        посредством Bugzilla(?ссылка), посредством которой взаимодействует 
	с сопровождающим.
	
	Ответственность: 
	
	Никакой (если редактор не назначен специально для подготовки выпуска
	документации).

Выпускающий(-ие):

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

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

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

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