[docs] Chapters and articles

cornet cornet на altlinux.ru
Ср Ноя 6 12:27:56 MSK 2002


"Anton V. Boyarshinov" wrote:
> 
> On Tue, 5 Nov 2002 12:26:02 +0300
> Alexandre <avp на altlinux.ru> wrote:
> 
> > Кроме того, вчера мы с Виталием Останиным обсуждали вопрос
> > включения jabber-common и Psi в документацию. Как вы видите,
> > оба документа включены в User guide. Однако, я настаиваю, чтобы
> > структура выглядела так:
> >
> > book - Руководство пользователя
> > ...
> > part - Сетевая коммуникация
> > chapter - Web
> > section - Введение
> > section - Mozilla Navigator
> > chapter - Mail
> > section - Введение
> > section - Mozilla Mail & News
> > chapter - Instant Messaging
> > section - jabber-common
> > section - Psi
> 
> При наличии всех перечисленных документов -- логично. Впрочем,
> это вопрос "оси" документации. Если мы делаем документацию
> ориентированную на задачи -- тогда так. 

Мне всё же таки кажется, что надо ориентироваться именно на
Задачи. Пользователь, садясь за компьютер, намерен решать именно
Задачи, а не копаться в имеющемся ПО, изучая тонкости.
Соответственно и документация должна быть сформирована именно с
точки зрения максимального облегчения поиска ответа на
пользовательский вопрос: "А чем тут делают Это и вот Это?". Это
особенно актуально именно по отношению к книге User.

Собственно и menus в данный момент сформировано именно по
задачам, а не по программам, и это правильно.

-- 
Власенко Олег.
Отдел технической поддержки ALT Linux Team.
mailto:cornet на altlinux.ru



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