Печка

Что в данном документе

Данный документ описывает общий принцип ведения обсуждений в конференциях 3ОС. Название "печка" происходит от русского выражения "танцевать от печки".

Далее по тексту слово "печка", употребляемое для обозначения принципов работы с документами, считается специфическим термином 3ОС и приводится без кавычек.

Для чего нужна печка

Печка служит для групповой работы над документами 3ОС и является отдаленным аналогом CVS, ориентированным на работу с HTML-документами.

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

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

Принцип работы печки

• координатором направления или другим участником проекта (с согласия координатора) вносится проект документа
• при поступлении на печку документ получает уникальное имя
• структура документа на печке должна предусматривать места, в которые будут вставляться ссылки на предложения и дополнения (обычно в конце каждой главы/раздела/подраздела)
• участники проекта вносят свои дополнения/предложения, ссылки на которые и вставляются в печку
• по решению ответственного за принятие документа, периодически производится его ревизия, и принятые поправки переносятся на печку
• все поправки, внесенные в печку, теряют свою индивидуальность и становятся частью печки
• процесс повторяется до тех пор, пока не будет получен окончательный вариант документа

Участие в печке

Для участия в печке нужно получить уникальный ник. Вместе с регистрацией ника в каталоге /usr документации 3ОС создается личный подкаталог участника проекта. Имя подкаталога совпадает с ником. Например, для ника ivanov будет создан подкаталог /usr/ivanov.

Предложения, присылаемые на печку, сохраняются в их личном каталоге. При отправке поправок в конференцию должны соблюдаться правила пересылки вложений, регулируемые соответствующими правилами.

Технические аспекты

• места для вставки тегов к дополнениям на печке должны обозначаться тегами <a name="имя"></a>
• имена тегов должны быть уникальны в пределах документа
• имена файлов с поправками к печке также должны быть уникальны в пределах личного каталога пользователя
• все документы, относящиеся к печке, сохраняются в каталоге /oven (в некоторых случаях возможно создание отдельных подкаталогов внутри /oven)
• все документы и поправки должны иметь собственный URL
• в процессе обсуждения, а также принятия поправок к документам во избежание разночтений рекомендуется использовать соответствующий URL
• после очередной ревизии печки участникам проекта обязательно рассылается обновление, включающее в себя все измененные документы
• аналогично обновления рассылаются при постановке документа на печку и снятии с нее