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

Kirill Maslinsky kirill на altlinux.org
Пн Июл 9 15:04:51 MSD 2007


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 --
несомненно, но это вопрос к разработчикам(у) альтератора.

-- 
Кирилл Маслинский
Альт Линукс
руководитель издательских проектов
http://heap.altlinux.ru


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