[docs] docs plans

Anton Farygin rider на altlinux.com
Ср Дек 24 01:01:15 MSK 2003


Michael Shigorin wrote:
> On Tue, Dec 23, 2003 at 07:50:04PM +0200, Maxim Tyurin wrote:
> 
>>В документации для Мастера (в руководстве администратора) очень
>>не хватает описания именно особенностей дистрибутива. 
> 
> 
> Неочевидностей... "см. alt faq на atmsk.ru"?

Нет.

IMHO именно описание особенностей.

И вообще, на мой взгляд корректная документация по программному продукту 
должна предоставлять пользователю:

1) Справочник по программам/опциям
2) Описание примеров эффективного использования программ и их опций

Это имеет отношение ко всем составным частям документации, включая 
руководство администратора или разработчика.

Т.е. - фактически нам нужно иметь алфавитный справочник команд 
(программ, библиотек, функций) и некую книгу, рассказывающую о том как 
это все использовать для решения тех или иных задач.

В концепции, предложенной Сашей я не увидел подобного подхода к 
составлению документации. Концепция, скорее, предлагает пользователям 
ряд статей, объединенных по тематикам и описывающих те или иные кусочки 
системы.


Rgds,
Rider




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