Fwd: re: [docs]

[Michael Shigorin]

----- Forwarded message from Alexandre Prokoudine -----

Alex Ott wrote:
> я имел ввиду даже не автоматизацию выкладывания, а то - как ведется
> разработка документации. я сейчас не вижу конечного результата
> собирания этой документации
>
> в чем проблема того, что кто-то поправит документ автора - может так
> лучше звучать будет? просто если сейчас мой документ поправят в куче,
> мне понадобится его брать оттуда, делать diff, вспоминать, я это
> изменение делал или нет и т.п.
>
> и что мешает в одной системе хранить как оригинальный текст, который
> писал автор в своем любимом формате, и его представление в том
> формате, в котором он принимается для выдачи документации

Между делом тут возникла производственная необходимость сменить
принцип разработки и хранения документации Audacity, над которой
сейчас работает  не менее трёх человек.

Оказалось, что упомянутый мной ранее в этом списке расылке вики-движок
Instiki умеет не только делать экспорт в PDF, но ещё и может собрать в
кучку нужную часть документации в виде ZIP-архива с HTML.

Идея использовать wiki-разметку устроила всех авторов документации.
Возможность отслеживания изменений - тоже.

Между прочим, многие wiki-движки (например, MediaWiki) умеют
генерировать RSS-ленту, благодаря которой можно отслеживать изменения
как отдельной страницы, так и всей вики в целом. Это очень удобно для
редакторов и авторов - в частности, в тексте каждой новости потока
вики на основе Mediawiki показаны изменения (два столбца - что было и
что стало), дата  и их автор. Instiki тоже так умеет.

Я держа три таких потока в своём RSS-агрегаторе - для вики на
openfontlibrary.org, для проекта CREATE, куда складываю свои спеки для
"графического" софта, и для вики документации к гимповому "шумодаву"
GREYCstoration, которую [документацию] понемногу перевожу на русский.
Раз в день запускаю агрегатор почитать новости и заодно смотрю, есть
ли изменения и какие.

Просто и удобно. Рекомендую.

А.П.

----- End forwarded message -----

-- 
 ---- WBR, Michael Shigorin <mike на altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/