[docs] черновик " Как это делают профессионалы "

[Kirill Maslinsky]

On Thu, May 31, 2007 at 09:35:16PM +0300, Artem Zolochevskiy wrote:
> В сообщении от Thursday 31 May 2007 16:18:52 Kirill Maslinsky написал(а):
> 
> > > Разработчики ALT Linux приложили все усилия, чтобы сделать вашу работу
> > > с Linux максимально простой. Используя созданные средства
> > > конфигурирования, вы можете вносить все необходимые при повседневной
> > > работе изменения в системе. Но выжно понимать, что, даже имея средства
> >
> > Лучше назвать явно средства настройки (конфигурирование -- слово тоже
> > какое-то неказистое)
> 
> Здесь вот какая история. Сперва я так как ты говоришь и сделал. Но потом 
> подумал о использовании этого текста (а как я понимаю он станет одим 
> из "можулей" документации) в будущем. И... а като его знает как они (эти 
> самые средства настройки будут назваться и вообще будут ли)
> Или я зря задумываюсь об этом?

Конечно не зря, но тут нужно соблюдать некий баланс между
абстрактностью/конкретикой в изложении: если сделать текст уж
слишком универсальным и "на века", то он может стать бесполезным.
Понятно, что стоит избегать выражений, которые устареют через 
неделю/месяц, но пытаться просчитать развитие на годы вперед --
тоже тщетное дело.

> > Общее соображение: даже важнее конкретного примера для этого
> > раздела, на мой взгляд, научить добывать информацию о релевантных
> > конфигах их доступных параметрах и синтаксисе.
> 
> Об этом я тоже думал. Можно и немного в эту тему повествование развернуть. Но 
> мне кажется что это более относится к модулю про документацию.

Есть варианты: 
 
 - поиск информации о конфигах описать в модуле про документацию, а 
   модуль про документацию поставить сразу после модуля/ей про настройку
   через GUI/web. Из тех соображений -- что чтение документации -- это
   всегда для настройки системы, и наоборот, какая же настройка без 
   документации.
 - можно в модуле про настройку сделать коротенький раздел про то, 
   что можно настраивать правкой конфигов и поставить отсылку на 
   модуль про документацию, где это описано подробно.
 - если получится, что текст про правку конфигов довольно специфичен 
   для модуля про настройку и тесно с ним связан по тексту, то лучше
   его в этом модуле и оставить. А модуль про документацию поместить
   где-нибудь рядом в качестве общей/дополнительной информации.
   
Тут в общем можно выбирать на вкус -- у всех вариантов свои
преимущества по простоте/удобству написания, а для читателя они в итоге
будут более/менее эквивалентны: ему в этой ситуации главное не порядок, а
информативность изложения.

> Спасибо Кирилл за все замечания!

Стараюсь быть полезным :)

-- 
Kirill Maslinsky
ALT Docs Team
http://heap.altlinux.ru