[docs]ВНИМАНИЕ: отчёт и насущные проблемы
Alexandre Prokoudine
avp на lrn.ru
Ср Янв 12 15:40:10 MSK 2005
Alex Ott пишет:
> P.S. На мой взгляд - не стоит сосредотачиваться на написании
> руководства по линуксу - лучше описать процедуру установки,
> а также ALT-вскую специфику, остальные книги по линуксу пользователь
> найдет/прочитает если заинтересуется, благо их есть и много.
Здесь я с тобой не соглашусь.
Я не просто так спросил про миссию проекта ниже. Если просто описывать
специфику ALT -- да это очень удобно, потому что не требует больших
человеческих и временных ресурсов.
Но. В реальности никакой консолидированной работы по написанию
документации, если не считать проект Сорекса, нету. По большому счёту,
как только дело доходит до написания документации, вся суть командной
работы в опенсорсе вдруг проваливается куда-то в бездну, да так глубоко,
что звука падения её тушки не слышно вовсе.
Когда человек пишет доку по интересному её софту, он пишет в первую
очередь о самом софте, и только потом -- о специфике окружения. То есть
в нормальной доке всегда есть определённый уровень абстракции от
окружения (разумеется, не ко всем докам это применимо, однако же).
Простой пример. Я сейчас пишу "Building and installing JAMin". Сначала я
описываю сборку и установку базового для JAMin софта из исходников, и
только потом о том, как установить весь этот софт в Debian, Gentoo, FC3,
ALT, SuSE и т.д. Почему? Потому что я заведомо полагаю свою доку
полезной для всего множества пользователей, а не только для подмножества
ALT или Gentoo.
Ты когда-нибудь просил авторов сторонней (относительно ALT) документации
написать что-нибудь для ALT? Стандартный ответ: "Нуууу.... Я использую
RedHat.... Так что даже не знааааюююю....".
Сама суть написания доки к опенсорсному продукту состоит в том, чтобы
донести её до максимально возможного количества людей, вне зависимости
от их пола, национальности, вероиспо^^^^используемого дистрибутива. Ты
ведь и сам пишешь доки по Emacs, не завязываясь на дистрибутивы ;)
Итак, возвращаясь к миссии. Мне лично было бы приятно, если бы миссией
ALD стало создание и поддержка свободной платформы для документирования
опенсорсного софта.
А.П.
Подробная информация о списке рассылки docs