[docs] Re: docs plans

Anton Farygin rider на altlinux.com
Чт Дек 25 20:29:22 MSK 2003


Alexandre Prokoudine wrote:
> Anton Farygin wrote
> 
>>>Зачем? Электронный справочник гораздо удобнее.
>>
>>Продемонстрируйте мне, пожалуйста, готовый электронный справочник на 
>>русском языке, в котором будут одновременно лежать описания утилит ls, 
>>cd, grep и sed. К тому же этот справочник все-таки должен быть 
>>структурирован по типу применения (что бы было просто найти, с помощью 
>>чего это сделать).
>>
>>Для примера - у нас есть классный электронный справочник man. Попробуйте 
>>в нем быстро найти утилиты, с помощью которых можно получить:
>>1) имя каталога из полного пути к файлу
>>2) количество строк в файле
>>3) утилиту, уменьшающую размер текстового файла методом замены пробелов 
>>на табуляцию.
> 
> 
> В плане разделов Руководства пользователя ясно вижу у себя:
> 
> 5. Вводный курс по работе с командной строкой.

Какой же он вводный ??? ;-)

Насколько я знаю - утилита, заменяющая пробелы на табуляцию - вообще 
_нигде_ не описана, кроме как в man'ах.

Т.е. - вводный курс преввращается в полноценное руководство по 
coreutils, bash, sed, awk и т.д. ?

> 
> 
>>>>и некую книгу, рассказывающую о том как 
>>>>это все использовать для решения тех или иных задач.
>>>
>>>
>>>То есть первично решение задач. Именно то, о чём писал Саша.
>>>
>>
>>Да, но без описания инструментов решения этих задач документация 
>>становится сильно неполной. К тому же - лучше всего вообще убрать из 
>>документации описание пользовательских приложения (аля audacity или 
>>psi), т.к. непонятно что будет лучше в момент выпуска дистрибутива. Или 
>>- разработать технологию формирования печатной документации из 
>>электронной таким образом, что бы можно было составлять набор "пакетов" 
>>по такому же принципу, по какому мы составляем дистрибутивы.
> 
> 
> Я не понимаю, о чём мы спорим. Никто не говорит об отказе от описания 
> инструментов. Я просто не хочу превращать документацию в справочник,
> потому что руководство пользователя и справочник не тождественны.

Руководство пользователя может содержать справочник.

Rgds,
Rider




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