From: Kirill Maslinsky <kirill@altlinux.ru> To: ALT Devel discussion list <devel@lists.altlinux.org> Cc: Alexey Smirnov <smi@altlinux.ru> Subject: [devel] пора документирования инсталлятора Date: Fri, 12 Jan 2007 16:27:10 +0300 Message-ID: <20070112132710.GT30439@tacit.myxomop.com> (raw) [-- 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 --]
next reply other threads:[~2007-01-12 13:27 UTC|newest] Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top 2007-01-12 13:27 Kirill Maslinsky [this message] 2007-01-12 13:37 ` Kirill Maslinsky
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20070112132710.GT30439@tacit.myxomop.com \ --to=kirill@altlinux.ru \ --cc=devel@lists.altlinux.org \ --cc=smi@altlinux.ru \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
ALT Linux Team development discussions This inbox may be cloned and mirrored by anyone: git clone --mirror http://lore.altlinux.org/devel/0 devel/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 devel devel/ http://lore.altlinux.org/devel \ devel@altlinux.org devel@altlinux.ru devel@lists.altlinux.org devel@lists.altlinux.ru devel@linux.iplabs.ru mandrake-russian@linuxteam.iplabs.ru sisyphus@linuxteam.iplabs.ru public-inbox-index devel Example config snippet for mirrors. Newsgroup available over NNTP: nntp://lore.altlinux.org/org.altlinux.lists.devel AGPL code for this site: git clone https://public-inbox.org/public-inbox.git