[docs] plans

Alexandre Prokoudine avp на altlinux.ru
Вт Ноя 11 16:02:02 MSK 2003


По просьбе трудящихся :)

> Во! В точку. И эта программа должна быть на главной странице проекта
> alt-docs (offtopic: например, в wiki). Далее всё -- отсебятина.
>
>   Для делается сейчас:
>
>   * обновление make-файлов для использования профилей, а также для
>   * возможности мгновенного переключения способа генерации PDF (ведь
>   * пока ещё неизвестно, как собирать PDF).
>
>     Предлагаемые цели:
>
>     * тех.часть: сделать генерируемые PDF идеальными.

Такое стремление давно есть :)

>
>     * тех.часть: сделать _нулевой_ порог вхождения для написания 
>       документации (устранить все барьеры в виде docbook, cvs, etc; 
>       принимать тексты хоть в Ворде).

Вообще-то, тексты и так принимаются в любом формате, равно как и патчи.

>
>     * мессионерская часть: поиск авторов и текстов

Происходит, хотя вяло. Предвидя вопрос "почему", отвечаю: документация
сейчас пишется из расчёта на включение в тот или иной 
дистрибутив/решение. У нас уже был опыта писательства "вслепую", который я
не решился бы назвать удачным. Как только будет определено ТЗ для
следующего дистрибутива/решения, начнётся поиск авторов.

Я сомневаюсь в необходимости накопления массива документации, в которой
разнятся стиль подачи, объём и актуальность информации.

Да, существует необходимость в некоторой информации, которая будет
востребована всегда. Например, сейчас нехватает хорошей вводной части для
совсем неопытных пользователей. Свой опыт с quickstart я считаю скорее
неудачным, поэтому буду признателен за конкретные предложения. А пока я 
предлагаю создать в CVS/docs отдельный каталог для текстов, 
предназначенных именно для такой целевой аудитории.

>
>       Устоявшийся процесс:
>
>     * Авторы пишут тесты (да, хотя бы в Ворде, например). Редакторы
>     * перегоняют в docbook и в cvs.

Редактор не должен этим заниматься, редактор должен редактировать :)
Преобразованием должен заниматься и.о. конвертера :)

>
>     Если это будет обсужлаться -- надо создать отдельную ветку.

См. начало :)
	  

-- 
Alexandre Prokoudine		| "When you set yourself on fire and aim 
ALT Linux Documentation Team	|  for the sky, you hope to leave behind 
E-mail: avp на altlinux.ru		|  some sparks of heat and light"
JabberID: avp на altlinux.org	|                             Neil Peart
----------- следущая часть -----------
Было удалено вложение не в текстовом формате...
Имя     : отсутствует
Тип     : application/pgp-signature
Размер  : 189 байтов
Описание: отсутствует
Url     : /pipermail/docs/attachments/20031111/3028c949/attachment.bin


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