[docs] docs plans
Andriy Dobrovol's'kii
dobr на iop.kiev.ua
Ср Дек 24 16:56:55 MSK 2003
Alexandre Prokoudine wrote:
> 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) Описание примеров эффективного использования программ и их опций
>
>
> Не вижу заметных расхождений в этом пункте с моей концепцией.
>
>
>>Это имеет отношение ко всем составным частям документации, включая
>>руководство администратора или разработчика.
>>
>>Т.е. - фактически нам нужно иметь алфавитный справочник команд
>>(программ, библиотек, функций) и некую книгу, рассказывающую о том как
>>это все использовать для решения тех или иных задач.
>>
>>В концепции, предложенной Сашей я не увидел подобного подхода к
>>составлению документации. Концепция, скорее, предлагает пользователям
>>ряд статей, объединенных по тематикам и описывающих те или иные кусочки
>>системы.
>
>
> Статья в контексте нашей коробочной документации -- скорее, стилистический
> нонсенс, чем нечто, предложенное мной в рамках концепции.
В идеале, я хотел бы иметь то, что описал Антон. Но, в подаче
Александра. :) Справочный стиль по имеющимся программам с примерами
их рекомендуемого применения в контексте задач. Н...да, надеюсь
понятно выразился. :)
--
Rgrds,
Andriy
*********************************************************************
email: dobr at iop dot kiev dot ua Kyiv, Ukraine
Phone: (380-44) 265-7824 Department of Gas Electronics
Fax: (380-44) 265-2329 Institute of Physics of NASU
*********************************************************************
Подробная информация о списке рассылки docs