[docs] далее о docs-alterator

Artem Zolochevskiy artem.zolochevskiy на gmail.com
Пн Июл 16 00:40:49 MSD 2007


hi all

Так как обсуждение целей docs-alterator* чуть выше заглохло, то опишу как я 
себе вижу ситуацию.

Модули alterator-* встречаются как в виде "Центра управления системы" так и в 
виде шагов инсталлятора. Причём надо заметить, что в инсталляторе они могут 
иметь несколько иную компоновку (табы и т. п. -- см. настройки сети).

Есть docs-alterator* , призванные описать соответсвующие alterator-* модули. 
Вопрос в том, может ли текст docs-alterator-* быть  универсален и для 
прочтения его в контексте инсталлятора и в контексте Центра управления 
системы? Мне думается, что, конечно, может, но это привносит определённые 
трудности при составлении текста.
Пример: docs-alterator_network-kirill. Вот этот модуль замечательно читается в 
контексте Центра управления системы, но не очень хорошо в контексте 
инсталлятора. Уже по той причине, что спрева речь об общих сетевых 
настройках, а затем о IP-интерфейсах. А в инсталляторе они идут как раз в 
обратном порядке. Или модуль docs-alterator_users-kirill: Замечательно 
читается в контексте инсталлятора, но вот при применении его для описания 
модуля Центра управления уже могут возникнуть недопонимания. Ну нет там (в 
Центра управления) ничего про root.

С другой стороны, с привнесением скриншотов в документирование инсталлятора, 
docs-alterator-* окончательно теряют даже ту универсальность, которую имеют.

Что будем делать?

Что я вижу:
* docs-alterator-* дублируют справку web-конфигуратора.
* описания  alterator-* , встречающиеся на стадии установки получают какие-то 
имена не пересекающиеся с docs-alterator*

Какие есть минусы:
* docs-alterator-* вроде как задумывались не как "справка" а 
как "разъяснительная документация"
2kirill: можешь тут подробнее?

Плюсы:
* А может и "справка" web-конфигуратора с удовольствием 
станет  "разъяснительной документацей" и тогда от их объединения все только 
выиграют?
* решение проблемы "скриншотов"

Кто что мыслит?

-- 
Артём Золочевский


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