|
Размещение документов 3ОС |
Данный документ описывает правила, согласно которым должна размещаться документация 3ОС на локальных и сетевых носителях, т. е. на сервере и персональных компьютерах участников проекта.
Правила размещения документов созданы для упорядочивания различной документации, относящейся к проекту 3ОС. Упорядочивание преследует несколько целей:
Вся документация, созданная участниками проекта 3ОС, должна храниться в одном месте. В общем случае для этого создается отдельный каталог где-либо на носителе. Размещение файлов внутри каталога, а также создание внутри него подкаталогов подчиняется определенным правилам.
Настоящими правилами регламентируются:
Корневой каталог документации 3ОС может быть расположен в любом месте, какое удобно пользователю.
По желанию пользователя, документация в любой момент может быть перемещена в другое место. Для этого достаточно перенести корневой каталог со всем содержимым средствами используемой ОС. Никаких дополнительных обслуживающих действий при переносе документации не требуется.
Аналогичным образом, корневой каталог документации также может быть свободно переименован.
Внутри корневого каталога документации размещаются только подкаталоги направлений работы. Порядок их размещения описан далее. Создание каких-либо других каталогов внутри корневого каталога документации запрещается.
Настоящими правилами запрещается также размещение каких-либо документов непосредственно внутри корневого каталога документации. В корневом каталоге могут находиться только подкаталоги, файл оглавления, а также вспомогательные файлы, как таблицы стилей (CSS), служебные файлы используемого ПО, например списки прав доступа.
В общем случае структура подкаталогов для хранения документации 3ОС должна повторять ее организационную иерархию. Следовательно, для каждой группы и подгруппы создается отдельный каталог внутри корневого каталога документации.
Вопрос о создании, перемещении, удалении или переименовании каталога группы (направления работы) решается главой или советом координаторов проекта.
Существующие на данный момент каталоги групп (направлений работы) перечислены в приложении.
Для удобства документация внутри каталогов групп (направлений) работы может быть разбита на тематические подгруппы, каждой из которых соответствует отдельный подкаталог. Общий список зарегистрированных подкаталогов приведен в приложении.
Документы, состоящие из нескольких объектов (файлов) также могут размещаться в отдельных подкаталогах как непосредственно внутри каталога группы, так и внутри подкаталогов. Количество подкаталогов и уровень их вложения не ограничивается.
Вопрос о создании, перемещении, удалении, и переименовании каталогов подгрупп, а также подкаталогов решается координатором направления работы или подгруппы внутри данного направления.
В понятие прочей документация входит:
Данный вид документации размещается в отдельной папке, название которой задается в приложении.
Документация 3ОС может быть размещена в системах, чувствительных к регистру символов. Поэтому, регистр символов имен файлов и каталогов должен везде сохраняться.
Кроме этого, при создании и переименовании каталогов должен соблюдаться единый стиль в оформлении имен. Например, имена каталогов могут начинаться с заглавной буквы.
Переименование и перемещение файлов и каталогов является нежелательной операцией, т. к. может затронуть большое число документов, имеющих ссылки. В результате неправильно произведенного переименования или перемещения ссылки могут перестать работать.
Чтобы избежать нарушения ссылок в документах 3ОС, переименование и перемещение файлов и каталогов 3ОС должно производиться при помощи средств построения сайтов, которые могут перенастраивать ссылки автоматически. После этого обязательно создание и распространение среди участников проекта пакета обновления, затрагивающего все измененные или перемещенные файлы и каталоги.
Согласно стандартам 3ОС, все документы должны иметь формат HTML. Данный формат позволяет создавать ссылки на документы, а также графические изображения, таблицы стилей, и другие объекты.
Все ссылки в документах 3ОС, в т. ч. на другие документы, разделы документов, картинки, таблицы стилей и др. объекты должны быть относительными. Исключение составляют ссылки на страницы, не относящиеся непосредственно к документации 3ОС, и расположенные в Интернете.
В процессе работы участниками проекта могут создаваться новые документы, а также изменяться уже существующие. Тиражирование изменений в этом случае происходит путем создания пакета обновления.
Пакет обновления в данном случае - это один или несколько файлов, относящихся к документации 3ОС, созданных или измененных кем-либо из участников. В общем случае тиражирование происходит через конференцию, поэтому пакеты обновлений направляются туда.
Создание пакетов тиражирования регулируется следующими правилами: