[docs] workflow

[Oleg A. Paraschenko]

  Привет!

  Во время Феста были обсуждения организационных проблем alt-docs.
На их основе я прикинул возможный вариант распределённого написания
документации. Комментарии приветствуются.


Автор пишет текст в удобном для себя формате (примеры: doc, sxw,
txt, docbook и т.д).

Автор предоставляет техпису текст. Техпис преобразует текст автора
в свой формат. Техпис использует некий инструмент (например,
openoffice с дополнениями) для вычитки и логической (пере)разметки
текста.

Техпис вносит в систему результат своей работы в неком внутреннем
формате (например, xml). Система преобразует документы из
внутреннего формата в нужные форматы (html и pdf).

Верстальщик доводит внешний вид документов до идеального состояния.
Система запоминает исправления и при следующем генерации документов
пытается применить их автоматически.

О форматах.

Внутренний формат не важен ни автору, ни техпису, ни верстальщику.

Автор использует то, что удобно ему. Он размечаеи текст по
минимуму, используя не более 5-6 тегов (заголовок, параграф,
выделение и т.д.). Автор придерживается стандартного способа
разметки. Эти соглашения есть для всех исходных форматов.

Преобразование из внутреннего формата в авторский формат происходит
с потерей информации. Преобразование из авторского формата во
внутренний формат невозможно.

Техписовский формат и внтренний формат взаимно однозначны.
Преобразование между ними происходит без потери информации.

Внесение изменений.

Только техпис имеет право вносить изменения в систему.

Если изменения хочет внести автор, то автор обращается к системе и
система возвращает документ в виде, пригодном для внесения
изменений. По окончании работы автор передаёт результат техпису.
Техпис переносит изменения в систему.


-- 
Oleg Paraschenko  olpa@ http://xmlhack.ru/  XML news in Russian