[docs] Возможная организация документации

Vadim Vinichenko vnv на 14000.ru
Пт Янв 17 14:05:06 MSK 2003


Andriy Dobrovol's'kii пишет:

<skipped/>
> Проблема не в наличии разметки.
> _Проблема_в_наличии_права_что-то_править._
> И именно эту проблему нужно решать. А разметку, при вычитке вообще 
> трогать незачем, ИМХО. Это удел тех. редакторов. :) Нужна возможность 
> именно литературной корректуры. 

IMHO, и при содержательной вычитке от разметки абстрагироваться трудно. 
Литературная правка может быть "нелокальной". Довольно часто документ 
выползает из головы на бумагу не том порядке, в каком его удобно читать. 
"Литературная правка" такого документа может включать различные 
манипуляции с его структурой, причем не только перестановку крупных 
блоков, но и мелкую перетасовку отдельных абзацев и предложений. При 
этом хорошо бы не попортить структурную разметку (section, title, по 
крайней мере), а иногда бывает нужно ее скорректировать. Или, например, 
сбросить текст в сноску - нормальная операция содержательного 
редактирования, но без понимания разметки не обойтись. Впрочем, проблемы 
не фатальные, и через трупы ходить не нужно:-)

Есть еще та проблема, что разметка сильно мешает (мне, по крайней мере) 
воспринимать текст, как целое. Но, как уже подсказали, ее можно 
отключить, можно вычистить простым регэкспом, создав отдельную версию 
для чтения, а можно, в принципе, и сгенерировать документ (если знать, 
как).

>В тот момент времени когда у желающего 
> внести вклад есть время.

Вот! Я после опубликования схемы Document Flow уже высказывался на ту 
тему, что она не предусматривает ситуации, когда кому-то просто ударило 
в голову поправить какой-то конкретный документ, не надевая шапки 
Официального Литературного Вычитывателя. Для корпоративного проекта, где 
люди выполняют предписанные обязанности, получая за это зарплату, эта 
схема, наверное, адекватна. Но для проекта со значительным участием 
добровольцев (Добровольского и прочих:-)) можно ожидать, что 
значительная часть их вклада будет иметь место именно в форме таких 
спонтанных инициатив, а не официальных вычиток.

<skipped/>

--
С уважением,
Вадим




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