[docs] Re: Q: docs status

Vitaly Ostanin vyt на vzljot.ru
Пт Окт 4 19:09:21 MSD 2002


Dmitry V. Levin пишет:
> Greetings!
> 
> В связи с планами по выпуску Мастера осенью этого года необходимо
> обеспечить своевременную готовность документации.

Именно Мастера, не Junior ?

> Какие есть мнения о степени готовности документации на сегодняшний день?

Хотелось бы увидеть актуальный список задач, который составлял 
Александр Прокудин, если не ошибаюсь.

По памяти, если речь о документации в DocBook:

1.
Уточнение правил документации и занесение их в docs-howto, например:
- использование буквы 'ё'
- обращение - на "Вы" или "вы", различается даже в одном и том же 
документе
- именование файлов со скриншотами
- формирование id для ссылок

2.
Перевод документации из формата OOo в DocBook - реально с помощью 
стилей Антона Бояршинова, admin уже переведён.

3.
Техническая вычитка всего полученного - реально при бОльшей 
активности.

4.
Обработка стилями, которых ещё нет:
- для вставки неразрывного пробела перед длинным тире
- проверка всех мест, где есть "пробел дефис пробел"
- проверка использования точки с запятой в конце перечислений
- проверка указания полного имени автора
- генерация списка авторов из включаемых документов, а не руками
Нужно написать эти стили, нерешаемых проблем тут нет, но нужно 
время и добровольцы.

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

6.
Литературная вычитка документов - реально.

7.
Редакторские правки - указание лицензий, документации, взятой из 
коммерческих продуктов, порядка документов и т.д. - реально.

8.
Получение приличной печатной версии. С этим сложно. Нужно решить:
- вопрос печати скриншотов (это возможно с passivetex ?)
- получение печатной версии с использованием olinking. Пока базу 
ссылок для создания конечного .fo файла мне получить не удалось.
- поиск огрехов в форматировании и вёрстке
- неплохо бы собрать FOP и посмотреть на его возможности


Вывод (IMHO) - при текущей (известной мне :)) активности авторов 
и техредакторов полная подготовка книг user, admin, install до 
конца осени маловероятна. Буду очень признателен, если меня 
разубедят...

<skipped/>

-- 
Regards, Vyt
mailto:  vyt на vzljot.ru
JID:     vyt на vzljot.ru
----------- следущая часть -----------
Было удалено вложение не в текстовом формате...
Имя     : отсутствует
Тип     : application/pgp-signature
Размер  : 252 байтов
Описание: отсутствует
Url     : /pipermail/docs/attachments/20021004/b006bdc1/attachment.bin


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