[docs] документация по модулям конфигураторов

Artem Zolochevskiy artem.zolochevskiy на gmail.com
Пн Июл 9 19:29:02 MSD 2007


В сообщении от Monday 09 July 2007 14:04:51 Kirill Maslinsky написал(а):
> On Fri, Jul 06, 2007 at 09:43:02PM +0300, Artem Zolochevskiy wrote:
> > hi all
> >
> > Что наблюдается у нас с конфигураторами.
> > Есть 2 конфигуратора:
> > - web (вроде как основной)
> > - qt (как скорее придаток)
> >
> > у web-конфигуратора есть справка -- это хорошо, и надо её стараться
> > улучшать. qt-версия частично документирована модулями docs-alterator...
> >
> > web и qt модули по идее предоставляют один и тот же функционал.
> > Т.е. отличий между конфигураторами, грубо говоря, и нет.
> > А если так, то может и справка qt-версии долна быть синхронной с
> > web-версией? Думаю, это позволит не тратить усилия на описания одного и
> > того же явления двумя различными текстами.
> > А то но один и тот-же модуль (с абсолютно идентичной функциональноситью),
> > имеет разную справку в зависимотри от вида конфигуратора..
>
> Справка и разъяснительная документация по возможным способам
> использования ПО -- это разные тексты, которые строятся по-разному
> и не совпадают по задачам (и обычно, по объёму). Поэтому модули
> docs-alterator-* не дублируют справку, а дополняют ее, и должны быть
> самостоятельными текстами.

Кирилл, но по факту там пишется то же самое, просто иными словами. Так стоит 
ли одно и то же яваление описывать дважды разными словами?

>
> То, что справка в qt должна быть той же самой, что и в web --
> несомненно, но это вопрос к разработчикам(у) альтератора.

Не понял. так какова роль docs-alterator-*. Я думал, что описание 
соответсвующих модулей alterator. 
Или ты говоришь о разнице "описание" и "справка".
Тогда давай уточним, что есть что. ибо по факту я вижу, что docs-alterator-* 
это такая "справка" на qt-конфигуратор, которая ориантироа скорее на процесс 
утсановки системы. т.е эти тексты хорошо читаются при проходении процесса 
установки, кде и фигурируют те или иные модули alterator. но вот после 
установки, если рассмастривать qt-конфигуратор как просто самостоятельную 
единицу, то как-то справка от web-версии гораздо больше подходит к нему чем 
docs-alterator-*

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


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