[devel] пора документирования инсталлятора

[devel] пора документирования инсталлятора

[Kirill Maslinsky]

[-- Attachment #1: Type: text/plain, Size: 4417 bytes --]


Всем добрый день!

Настала пора (даже пора неподходящее слово -- давно пора) 
документировать инсталлятор. 

Для заинтересованных в сроках каких-либо выпусков, включающих
инсталлятор: документирование в нормальной ситуации 
(с обычным уровнем неожиданностей и катастроф) должно занять 
примерно МЕСЯЦ (без учета переводов на другие языки).

Чтобы можно было начать документировать, необходимы ответы на 
следующие вопросы: 

1. Как получать актуальные (последние) образы инсталлятора? 

   1.1. Есть ли гарантия актуальности образов, публикуемых на 
        ftp.altlinux.org:/pub/people/legion/iso/ ? 

   1.2. Образы по указанной выше ссылке очень велики. Есть ли
        возможность сформулировать инструкцию для самостоятельного
		изготовления образов? 

		frbrgeorge@ высказывал готовность составить такую инструкцию
		при наличии информации. Иметь такую инструкцию было бы в 
		любом случае предпочтительно.

2. Какие компоненты инсталлятора ГОТОВЫ к документированию?

   Готовность к документированию означает, что внесение 
   каких бы то ни было изменений в интерфейс, логику
   работы и функциональность модуля возможно ТОЛЬКО 
   при соблюдении ОБОИХ нижеприведённых условий:
	   
	   1. Изменение является исправлением, и мотивировано
	   ОПУБЛИКОВАННЫМ bug request'ом.

	   2. Разработчик ПРЕДУПРЕЖДАЕТ документирующего о внесении 
	   изменения, указывая на соответствующий bug request.

   Можно ли при определении готовности к документированию 
   использовать данные со страницы
   http://wiki.sisyphus.ru/SisyphusRelease/Uranus/PersonnelWorks ?
   
   На настоящий момент я там обнаружил только одну отметку STABLE 
   для alterator-control. Означает ли пометка "beta" готовность 
   к документированию в указанном выше смысле? 

3. Как документировать?

   Необходимо описание процесса документирования инсталлятора: 
   
   1) в каком формате создавать документацию, 
   2) как ее включать в соответствующие компоненты инсталлятора,
   3) как тестировать (просматривать) результат добавления документации.

4. Как сообщать об ошибках?

   Документирование обязательно выявит ошибки и непоследовательности
   в работе документируемых компонентов. Куда и как помещать сообщения
   об ошибках, полученные в процессе документирования? 
   
NB:Для таких сообщений должна быть гарантия быстрой и адекватной реакции, 
   в противном случае документирование превращается в борьбу со слепой
   стихией, что мне представляется нецелесообразной тратой ресурсов.


-- 
Kirill Maslinsky
ALT Linux Documentation Team
http://heap.altlinux.ru

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [devel] пора документирования инсталлятора

[Kirill Maslinsky]

[-- Attachment #1: Type: text/plain, Size: 649 bytes --]

On Fri, Jan 12, 2007 at 04:27:10PM +0300, Kirill Maslinsky wrote:
> 
> Всем добрый день!
> 
> Настала пора (даже пора неподходящее слово -- давно пора) 
> документировать инсталлятор. 
<...>

Это письмо было адресовано в первую очередь разработчикам инсталлятора
в список devel-conf@, а сюда попало по ошибке. 

Прошу по возможности отвечать в devel-conf@.

-- 
Kirill Maslinsky
ALT Linux Documentation Team
http://heap.altlinux.ru

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]