[docs] Re: [translation-devel] Всё о ней, о документации (было russian mans - chroot(1))

[Kirill Maslinsky]

Доброе утро!

> Были ли эти руководства просто твёрдыми аналогами man pages? Какую роль 
> man pages играют сейчас в документации системы? Многие man'ы сильно 
> устарели. Практика подсказывает, что от вещи имеющей практический 
> интерес, многих легко может оттолкнуть её заброшенность.

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

Документация, наоборот, описывает решения _задач пользователя_ (ну или
администратора, разработчика, без разницы). Например, задача -- Настройка
печати, соответствующие объекты -- cups (и ман по нему), gs и т. д. Т. е. самый
минимальный раздел документации может состоять из ссылок на имеющие отношение к
теме маны (принцип RTFM в действии).

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

> Теперь позволю себе внести предложение. Хорошо, если в roadmap будут 
> учтены существование man'ов и конкретные шаги по их развитию. Мне 
> интересно наличие актуальных и добротных man'ов в системе, посему 
> скоординировав приоритеты и усилия, потихоньку двигал бы это направление 
> переводами и обновлением.

Так напишите соответствующий кусочек -- и в рассылку его. Включим в roadmap 
и вообще опубликуем, где только сможем. Вы же член команды! 
Если выйдет зажигательно, глядишь, народ потянется.

> Начав переводы, поступил просто: открыл документацию ALM2.4 и стал 
> переводить, один за другим, все встречающиеся man'ы.

Очень здравое решение, полностью согласуется с идеей, что маны и 
документация должны дополнять друг друга. Хотя если работать на будущее, 
нужно посмотреть и в более новые руководства по Compact 3.0.

> Сижу, перевожу очередной man и думаю: а куда подевалась практика, и даже 
> культура, документирования? Предания гласят, что каждая новая версия 

Куда, куда вы удалились...

-- 
Kirill Maslinsky
ALT Linux Documentation Team
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://lists.altlinux.org/pipermail/docs/attachments/20051108/c9ebf418/attachment.bin