[docs] о проектах (was: M24 docs impressions)

Kirill Maslinsky kirill на altlinux.ru
Ср Дек 8 18:46:13 MSK 2004


Привет.

> А можно, расскажу, как он начинался?

Здорово, вот уже некоторый материал для раздела "История проекта".

> Общий смысл моего понимания того, как подобный проект может быть
> устойчиво жизнеспособным и полезным для всех своих участников
> (а также широкого круга пользователей) -- это именно то, что люди
> делают вещи для себя тем образом, который им скорее удобен, при
> этом не боясь по ходу дела учиться и набираться опыта от коллег
> по команде; а вот фирма фокусируется на том, что нужно ей --
> обеспечении гарантированного качества некоторого подмножества
> результатов для того, чтобы снизить себестоимость поддержки
> создаваемых и поставляемых ею решений.  Не пытаясь перевалить
> бремя поддержания этого качества на волонтеров, btw.

Я пытаюсь найти именно удобный для всех способ поддержания документов
в актуальном состоянии. Или по крайней мере мониторинга этого состояния. 
Совершенно очевидно, что один человек не может следить за актуальностью
всех документов, и я нисколько никогда не претендовал на эту роль. 
Действительно, у каждого текста может быть человек, который по этому 
тексту эксперт: способен оценить его качество, соответствие действительности 
и т. п. И может обновить, если найдёт время и желание, потому что этот
текст ему бывает полезен самому. Короче говоря, аналог мантейнера.
И это не обязательно автор. Или должна быть определённость, что у какого-то 
текста такого человека нет. И, наверное, должен быть минимальный круг 
обязанностей у мантейнера, по возможности необременительный, но гарантирующий, 
что в любой момент можно сказать, чтО с данным текстом на сегодня. 

Хочу подчеркнуть, что автор совсем не обязан поддерживать свой текст, 
у него может не быть ни времени, ни мотивации. В этом случае нужно 
просто сдать его в orphaned. Речь совсем не идёт о том, чтобы перекладывать
ответственность на волонтёров.

> > Действительно важная проблема: оценка адекватности текстов.
> 
> Expires: ?
Вопрос, как бы это автоматизировать хоть отчасти. Если есть описание 
определённого ПО, можно смотреть, не сменились ли версии соответствующих 
пакетов, и, скажем, отправлять предупреждение. Впрочем, не все тексты 
устаревают.

> А не хотите написать "введение в docs" -- документ на манер
> maintainer's howto?  Буду рад помочь соображениями, если они
> будут признаны полезными и реализуемыми.

Теперь определённо хочу. Буду рад любым соображениям на эту тему.

> Ну, всё сложнее, но bugzilla у docs тоже есть. :)

Хитрость в том, что docs@ нужны две багзиллы: одна для уже собранной
документации, которая представлена в виде пакетов, другая -- для 
исходных авторских текстов (т. е. всех, которые есть в docs@). 
Или вторая -- излишество и вообще не нужна?

> Вышеуказанные пойдут в качестве дополнения ("более ранней
> стадии") к вашему с cray@ обсуждению?

Непременно.

> А у меня тоже возникло дежавю при прочтении.  Этого не должно
> быть, как это ни смешно. :)
Предложите, как переписать.

-- 
Kirill Maslinsky
ALT Linux Team * Documentation Project   



Подробная информация о списке рассылки docs