[docs] документация, инфраструктура, фирмы, сообщество

Kirill Maslinsky kirill на altlinux.ru
Чт Май 12 22:14:32 MSD 2005


Привет!
Замучался я отвечать, уже третий раз ответ переписываю, чтобы 
хоть сколько-то его сделать понятным и конструктивным.
Если туманно, прежде чем ругаться, задайте вопросы. 
Возможно, удастся достигнуть полезных практических результатов.

> Ну и сейчас вот думаю -- получится ли отвлечь Кирилла на то,
> чтобы посмотреть, чего там на этих самых wiki.sisyphus.ru и
> freesource.info/wiki/AltLinux (предшественник) накопилось и 
> где хорошей информации не хватает структуры (не контенту
> страничек, а самим страничкам), или нет.

1.
Документации по-любому у нас есть и будет два массива: вылизанная и
невылизанная.  Вылизанная идёт на бумагу и в дистрибутивы, она нужна offline.
Невылизанная самозарождается в _разных_ местах, в т. ч. на wiki.

Поэтому нет смысла структурировать wiki, ибо наличие жёсткой структуры --
свойство вылизанной документации, невылизанной, я бы сказал, жёсткая структура
противопоказана. Показаны средства индексирования (ключевые слова) и поиска.

2.
Из экономии ресурсов необходимо, чтобы вылизанная документация 
была подмножеством невылизанной. 

Проблема в том, что содержимое wiki жёстко привязано к конкретному
сайту, online. Вынуть документ наружу или засунуть внутрь wiki без 
интерактивного вмешательства человека и открытого броузера -- 
можно ли? 

Если возможности экспорта нет, значит, вылизывать документаци _в wiki_ 
нет смысла. А жаль, поскольку это оставило бы все преимущества wiki 
по оперативному обновлению и дополнению документа. Экспорт в виде 
cut-n-paste кусочков не больше страницы -- не годится. 

<JT>
После предложения такого способа работы приходится заподозрить, что 
Миша состоит в профсоюзе компьютеров и борется против их угнетения
человеком. Нет автоматизации! Вздумали тоже перекладывать работу 
на компы, пусть человек потрудится. И за 8-ми часовой рабочий 
день он выступал, я подозреваю, для того, чтобы компы не перегревались. 
А то они пашут почти круглосуточно, как пролетарии XIX века. ;)
</JT>

3. Как сделать экспорт.

Я попробовал wget wiki.sisyphus.ru/somewikipage

Посмотрел полученный html. Ну ужас, да, ужас, но не ужас-ужас-ужас. 
В принципе, возможно написать два regexp'а, чтобы откусить ненужные
заголовки и хвосты и оставить только содержание страницы в виде html.

Я уверен, что того же самого можно достигнуть и более простым способом,
это вопрос к тем, кто знает, как работает wiki. 

Чтобы полученный html был годен в качестве модуля вылизанной документации, 
нужно получить от wiki еще список авторов страницы (и редакторов, по 
возможности). 

Вот и всё, и экспорт готов. Реально сделать?
Если да, то часть вылизанной документации можно разрабатывать на wiki, 
включая сюда написание, редактирование и обновление текстов.

-- 
Kirill Maslinsky
ALT Linux Documentation Team
-------------- next part --------------
z'╣ЛmjшZr··э╡г+╧╤чtж╕zz-jЖ╒∙╕Еy<╘y╙i√'╤*'Ч≤)╡('jш╚y(Ё{_=o+^╟7╛rz-jЖ╒∙╕ЕyJЕ├шiЪЫb╡ш√ыb·Лk╩Зb╔ЙФj)v┤,Щ╚miхfz{lЪm4ГNuшЧ7ящyш▐з╤ж°├g╖╣╦╖


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