[docs] Re: Круглый стол по документации на конференции

Vitaly Ostanin vyt на vzljot.ru
Вт Июн 29 18:21:29 MSD 2004


Alexander Bokovoy пишет:
> Доброе время суток!

Здравствуйте

> Мы планируем провести на конференции круглый стол по вопросам ведения
> документации в свободных проектах. Предварительная программа включает в
> себя следующие темы:
> 
> 	- средства для разработки и представления документации
> 	- насущные проблемы документирования свободных проектов
> 	- стандартизация форматов
> 	- взаимодействие с пользователями: обратная реакция и динамическое
> 	  документирование как средство

Наверное, стоит скоординировать темы докладов.

Можно рассказать о проекте ALT Docs, выбранном формате 
DocBook/XML, принятых в ALT Docs способах модульной разработки 
документов, используемом ПО. О недостатках можно рассказать:
- отсутствие свободного WYSIWYG-редактора XSL-FO формата,
- отсутствие свободного WYSIWYM редактора XSL-стилей,
- отсутствие свободного, пригодного и массово удобного редактора XML.

(Кстати, специалисты по gtk2 и pygtk2 wanted - есть куча идей по 
поводу написания такого редактора и кое-какая реализация).

Можно рассказать о нише, занимаемой средствами наподобие 
сборочной среды ALT Docs - не офисные и не разнообразно 
оформленные документы.

О чём я мог бы (попробовать) рассказать (о насущных проблемах 
документирования):

- актуализация содержимого, автоматический отбор устаревшей 
информации;

- отслеживание процесса документирования: создание документа, 
лит. вычитка, тех. вычитка, переход в состояние готового 
документа. Саша Прокудин, если не ошибаюсь, как-то делал таблицу 
состояний документа.

- проблемы релизов документации (перевод её и сопутствующих 
файлов в автономное состояние);

Можно про портирование сборочной среды ALT Docs на win32, 
выбранное ПО, его интеграцию в среде win32 (не знаю, интересна ли 
эта небольшая тема слушателям, здесь в основном технические детали).

Вряд ли у меня будет большой доклад :)

> Предварительный список участвующих (выразили согласие и будут на
> конференции):
> 
> 	- Александр Прокудин
> 	- Антон Бояршинов
> 	- Александр Боковой

Наверно, меня можно считать выразившим предварительное согласие. 
С работы отпросился, приеду с вероятностью 98% :)

> Приглашаются все желающие, в том числе и с докладами на круглый стол.
> Очень хотелось бы видеть активных участников этого проекта.
> 


-- 
Regards, Vyt
mailto:  vyt at vzljot.ru
JID:     vyt at vzljot.ru
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 252 bytes
Desc: OpenPGP digital signature
Url : http://lists.altlinux.ru/pipermail/docs/attachments/20040629/82cf6a03/signature.bin


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