[docs] Re: coreutils

Vadim Vinichenko vnv на 14000.ru
Чт Мар 13 17:37:36 MSK 2003


Anton V. Boyarshinov пишет:
> On Thu, 13 Mar 2003 13:26:02 +0300 Alexandre Prokoudine
>  wrote:
> 
> 
>>2. Перевод/написание документации по coreutils (практически
>>вся)
>>
>>В данный момент мне более интересен второй пункт, поскольку уже
>>есть наработки Антона Бояршинова в данной области. Поэтому
>>выношу на обсуждение два вопроса:
>>
>>1. Стоит ли нам разделить документацию по coreutils на
>>пользовательскую/администраторскую части и соответствующие
>>фрагменты разделить между модулями, а затем и книгами, или же
>>просто перенести имеющееся в /admin?
> 
> Я считаю, что такие вещи должны быть именно в user. Когда я
> занимаюсь администрированием, я очень редко использую что либо
> отличное от vim & grep. А в работе и развлечении -- сплошь и
> рядом.
> 
> Кроме того, следует толково описать grep, find, sed по
> возможности awk. При этом я не считаю необходимым полный перевод
> документации. Главное -- показать какое богатство имеется в нашем
> распоряжении и продемонстрировать как оно удобно в использовании.
> Оригинальная документация не ставит этой задачи.
> 

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

Унесение всей консольщины в admin означало бы следование тому
сомнительному принципу, что в консоли работает исключительно
администратор, а пользователи только нажимают гуевые кнопки.

Мне представляется, что приоритетная задача данного проекта в консольной
области - не перевод _справочной_ документации (man, info) и, тем более, 
не ее издание (но последнее, строго говоря, относится к компетенции 
компании ALT).

Основная проблема с чтением man и info для очень монигих пользователей
(начинающих в области консоли и UNIX, при том, что в других областях они 
могут быть и весьма продвинутыми) состоит в том, что у читателя не 
хватает общей картины, контекста, в который он мог бы встраивать 
получаемые факты. Сами же man и info во многих случаях представляют 
собой более или менее упорядоченные собрания фактов, но оставляют желать 
лучшего с точки зрения формирования общей картины.

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

В то же время мне представляется, что актуальной задачей является как 
раз усиление "идеологической" (в некотором смысле) стороны документации 
ALT, той стороны, которая имеет отношение скорее к связному изложениею 
основных концепций, чем к собиранию фактов.

Поэтому я бы считал, что (применительно к консоли) в первую очередь 
имеет смысл подготовить обзор важнейших утилит с небольшим объемом 
справочной информации о каждой из них. Самое же главное, что хотелось бы 
видеть - демонстрация того, что, по распространенному мнению, и 
составляет The True Unix Way, а именно сопряжение множества простых 
инструментов для решения сложных задач.

Здесь мне представляется наиболее продуктивным следующий метод -
демонстрируется какой-нибудь эффектный пример из нескольких утилит, 
который поначалу может выглядеть навороченным, и затем подробно 
разбирается. Это, IMHO, гораздо эффективнее для формирования "правильной 
картины мира", чем подробный рассказ о многих настройках каждой из 
утилит, и позволяет ярче "показать богатство".

Разумеется, на все сказанное можно ответить, что это говорится о 
совершенно определенной целевой аудитории, и не имеет никакого отношения 
к вопросу о том, какая документация нужна или не нужна 
_администраторам_. Да, безусловно. Я только хочу сказать, что (1) 
актуальны и те задачи, о которых пишу я (и, похоже, Антон думает 
примерно о том же), и (2) инициативы по сколько-нибудь массивному 
переводу man'ов должы сопровождаться предварительным определением 
приоритетов.

Все сказанное, разумеется, не более, чем мнение.

--
С уважением,
Вадим





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