[docs] ВНИМАНИЕ: отчёт и насущные проблемы

Alexandre Prokoudine avp на lrn.ru
Ср Янв 12 14:35:08 MSK 2005


Kirill Maslinsky пишет:

>>Кирилл, извини, но я не вижу никакой прямой связи между количеством 
>>тегов в Db/XML и наличием сырых текстов. На моей памяти не меньше пяти 
>>человек просили простым русским языком дать им вводную документацию по 
>>докбуку. Её так никто и не написал. Потенциальные авторы на это 
>>посмотрели и быстро увяли. Это раз.
> 
> 
> Я, наврное, недостаточно отчётливо это проговорил. Связь есть между 
> количеством тегов и количеством людей, готовых поддерживать тексты 
> в соответствующем формате (и делать это грамотно, чтобы не пришлось
> потом переделывать). 
> 
> А что касается вводной документации по Докбуку, то я написал черновой
> вариант довольно давно. См. 
> http://lists.altlinux.ru/pipermail/docs/2004-August/004626.html

Это точно та ссылка?

> 
> При создании этого документа, я стави перед собой задачу описать
> те необходимые теги, которые действительно используются в DOCS.
> Фактически, подмножество DocBook, заданное документом, а не DTD. 

Воооот :) А теперь ответь, пожалуйста, на простой вопрос: чем на 
практике отличается  жёсткая дескриптивная регламентация используемых 
тэгов от жёсткой же регламентации тэгов при помощи DTD?

Ты хочешь подмножество? :) Смотрим

<section/>
	<sectioninfo>
		<author/>
		<releaseinfo/>
	<para/>
		<footnote/>
		<emphasis/>
		<filename/>
	<screen>
	<itemizedlist/>
		<listitem/>
	<orderedlist/>
		<listitem/>
	<variablelist/>
		<varlistentry>
			<term/>
			<listitem/>
	<figure/>
		<title/>
		<screenshot/>
	<table/>

Этих тэгов обычно хватает. Во всяком случае не помню, чтобы зва два с 
половиной года знакомства с докнюком я пользовался большим количество 
каких-то других тэгов.

А теперь мне хотелось бы посмотреть на человека, который не в состоянии 
разметить свой текст при помощи этих тэгов и нуждается в новом 
википодобном языке, разметку которого тоже нужно "учить".

Если мы переходим на wiki, то как будет выглядеть схема преобразований? 
wiki - docbook - TeX - HTML/PDF? И что, три языка разметки на 
официальном поддерживаемом уровне?

>>Три. Насколько я заметил (поправь меня если я ошибаюсь), вряд ли можно 
>>назвать дистрибутив ALT Linux, вышедший согласно расписанию. Это всегда 
>>добавляет проблем при планировании расхода время и распределении 
>>приоритетов. В условиях неопределённости мотивация контрибьюторов имеет 
>>весьма нездоровую, но легкопредсказуемую тенденцию сам знаешь к чему.
> 
> 
> Это основание, для того, чтобы развязать разработку документации и 
> выходы дистрибутивов. Ср. Сизиф, где разработка ведётся постоянно. 
> Однако модель Сизифа подразумевает, что есть мантейнер и багзилла.
> Поэтому, собственно, разработка идёт постоянно. 
> Согласен ли ты (и Общественность), что в проекте DOCS нужна аналогичная
> модель?

Меня очень смущает твоё представление о сопровождающем. Ты по факту 
требуешь от него не только знания нескольких языков разметки (а не 
только "упрощённого подмножества" докбука), но и глубокого погружения в 
тему текста автора. Это тогда уже не docs@, а фабрика по производству 
ницшианских сверхчеловеков :)

Мы сейчас лезем в дебри, не разобрав принципиально важный момент: цикл 
жизни документации на разных уровнях. Как только будет выработано чёткое 
представление о цикле жизни документации в рамках этого проекта, можно 
будет реально рассуждать об авторах и сопровождающих.

> Пожалуйста, назови с конкретными адресами в CVS и именами и email 
> ответственных сопровождающих, которые ответят на сообщения об
> ошибах и просьбы обновить документ новой версией документа. 
> Это поможет понять, насколько реально уже работает модель 
> сопровождающих и как.

Сопровождающих или авторов?

>>Четыре-два: Есть тексты, авторы которых до сих пор неизвестны.
> 
> Опять же: пожалуйста, назови.

Для этого мне нужно сначала довытащить CVS и посмотреть. По памяти, 
такие куски документации были как минимум в admin/.

>>Четыре-три: Есть авторы, которые про необходимость обновления док ничего 
>>не знали (например, Виталий Останин + Psi). Я лично не помню, чтобы в 
>>этот список рассылки постилось содержание хотя бы одной из книжек. 
>>Впрочем, пару месяцев я был отписан.
> 
> 
> Я уже писал в первом письме, почему я не мог позволить себе контактировать
> с каждым автором, не зная, согласится он сопровождать документ, или нет.
> 
> 
>>Пять. Вроде бы давно уже - года полтора как - было оговорено, что роль 
>>релиз-менеджера документации берёт на себя Виталий Останин. В таком 
>>случае меня слегка удивляет, что ты пишешь:
> 
> 
> Саша, ты мне об этом не говорил, Виталий тоже. А кто-нибудь знал кроме
> вас двоих? ;)

docs@

>>Где будет располагаться этот ресурс?
> 
> В принципе, это не очень существенно. На любом из серверов ALT, к которому
> разработчики смогут получить доступ на чтение хранилища.

ок

>>При всей красивости идеи реальность такого сценария сомнительна. Одно 
>>только "Руководство пользователя" насчитывает 16 глав на различные темы. 
>>Я теоретически могу представить себе пару мегагиперсопровождающих, 
>>который возьмут на себя по три главы из него. Что делать с остальными 
>>десятью главами? А ещё с тремя книгами?
> 
> 
> Мне не очень понятна природа этого распространённого мнения. 
> Объясните мне, почему в Сизифе сопровождающие поддерживают десятки 
> (и сотни!) пакетов, находя при этом реальным и необременительным
> для себя исправлять ошибки и следить за обновлением upstream.
> При этом поддержка даже одного документа, которая состоит 
> ровно в том же: своевременном обновлении и исправлении ошибок
> кажется невыполнимой задачей?

Пример:

ftp://ftp.altlinux.ru/pub/distributions/ALTLinux/Sisyphus/i586/RPMS.classic/
11/02/05 04:20             41 aube-0.30.2-alt1.i586.rpm

Это мой единственный пакет в Сизифе. Сборка с лета 2003 года не 
менялась. Судьба этого пакета меня давно уже не волнует, и за 
обновлениями upstream я не слежу. Но он в Сизифе.

Поэтому мне не очень понятна природа распространённого мнения, будто 
пакеты в Сизифе суперздорово поддерживаются. Разумеется, это не повод 
для гордости. Но именно так обстоит дело в реальности.

А.П.


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