[docs] приоритеты

Alexandre Prokoudine avp на lrn.ru
Пт Фев 25 18:25:52 MSK 2005


Michael Shigorin пишет:
> On Fri, Feb 25, 2005 at 03:42:39PM +0300, Alexandre Prokoudine wrote:
> 
>>>>Специфичный для alt тег один, <alt:distro>. Его нужно просто
>>>>вычистить из всех текстов, если мы документируем Сизиф.
>>>
>>>А смысл документировать сизиф?
>>
>>Смотря что понимать под документированием Сизифа.
>>(1) Документирование функционирования Сизифа как дерева разработки?
>>(2) Документирование софта в составе Сизифа?
>>Если мне не изменяет память, в начале всех недавних изменений речь шла о 
>>(3) документировании решений на основе Сизифа.
> 
> 
> Видишь ли, документирование анстейбла напоминает построение
> скребонёба на как минимум морене, а то и бархане, при этом
> начиная со стеклянной крыши и в четыре с половиной руки.

Миша, судя по всему в твоё понимание документирования анстейбла 
ненароком попадает документирование прикладнухи. А оно должно идти если 
не паралелльно разработке, то хотя бы попадать в ногу с ключевыми 
релизами. Когда человек садится и обновляет свои доки к некой интересной 
ему софтине от релиза к релизу -- это тоже документирование анстейбла, 
притом действие это вполне осмысленное и полезное. Не так ли?

Но это всё лирика. Хотелось бы увидеть в docs@ внятную политику 
приоритетов: какую именно *качественную*, т.е. вылизанную и сто раз 
выверенную документацию важнее иметь в первую очередь, какую -- во 
вторую очередь, в третью, ну и т.д.

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

а) многое нелокализовано (почитайте на досуге man sox -- масса 
удовольствия);
б) многие маны написаны исключительно коряво (например, плохо продумана 
структура и нет примеров использования программы);
в) масса разных форматов, причём только grep и последние новшества в 
KHelpBrowser и Yelp кое-как помогают разруливать это;
г) <допишите сами/>.

Надеюсь, не нужно объяснять, что электронные доки пользуют чаще 
бумажных. Но есть ли точное представление о том, что говорить человеку, 
который решил написать доку для ALT -- "пиши как для бумажной 
документации" или "пиши как для электронной"?

Между прочим, хотелось бы услышать официальное мнение Кирилла по поводу 
проекта l10n.lrn.ru, аггрегирующего усилия kde-ru@ и gnome-cyr@ в 
контексте "работаем вместе" или "они идут своим особым путём".

А.П.


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