[docs] docs plans
Alexandre Prokoudine
avp на altlinux.ru
Ср Дек 24 15:40:19 MSK 2003
Anton Farygin wrote
> Michael Shigorin wrote:
> >On Tue, Dec 23, 2003 at 07:50:04PM +0200, Maxim Tyurin wrote:
> >
> >>В документации для Мастера (в руководстве администратора) очень
> >>не хватает описания именно особенностей дистрибутива.
> >
> >
> >Неочевидностей... "см. alt faq на atmsk.ru"?
>
> Нет.
>
> IMHO именно описание особенностей.
>
> И вообще, на мой взгляд корректная документация по программному продукту
> должна предоставлять пользователю:
>
> 1) Справочник по программам/опциям
Так называемое "путешествие по менюшкам"? IMHO, ему место в электронной
справке.
> 2) Описание примеров эффективного использования программ и их опций
Не вижу заметных расхождений в этом пункте с моей концепцией.
>
> Это имеет отношение ко всем составным частям документации, включая
> руководство администратора или разработчика.
>
> Т.е. - фактически нам нужно иметь алфавитный справочник команд
> (программ, библиотек, функций) и некую книгу, рассказывающую о том как
> это все использовать для решения тех или иных задач.
>
> В концепции, предложенной Сашей я не увидел подобного подхода к
> составлению документации. Концепция, скорее, предлагает пользователям
> ряд статей, объединенных по тематикам и описывающих те или иные кусочки
> системы.
Статья в контексте нашей коробочной документации -- скорее, стилистический
нонсенс, чем нечто, предложенное мной в рамках концепции.
--
Alexandre Prokoudine | "When you set yourself on fire and aim
ALT Linux Documentation Team | for the sky, you hope to leave behind
E-mail: avp на altlinux.ru | some sparks of heat and light"
JabberID: avp на altlinux.org | Neil Peart
----------- следущая часть -----------
Было удалено вложение не в текстовом формате...
Имя : отсутствует
Тип : application/pgp-signature
Размер : 189 байтов
Описание: отсутствует
Url : /pipermail/docs/attachments/20031224/434436f9/attachment.bin
Подробная информация о списке рассылки docs