7. Создание фрагментов
Как уже говорилось выше, для обеспечения контроля версий разрабатываемой документации используется система Subversion и ее графическая оболочка TortoiseSVN. Для начала работы создадим рабочую копию (рисунок 2, рисунок 3).
Далее необходимо добавить в рабочую копию заготовки технической документации, описанные в разделе 5. Воспользуемся TortoiseSVN (рисунок 4, рисунок 5).
Рисунок 2 - Создание рабочей копии
Рисунок 3 - Результат создания рабочей копии
Рисунок 4 - Добавление заготовок фрагментов в рабочую копию
Рисунок 5 - Результат добавления файлов в рабочую копию
Теперь необходимо зафиксировать изменения (рисунок 6, рисунок 7).
Рисунок 6 - Фиксация изменений, сделанных в рабочей копии
Рисунок 7 - Результат выполнения фиксации изменений
При создании документации используются также графические файлы, например картинки, которые также необходимо добавить в рабочую копию (рисунки 8,9).
Рисунок 8 - Фиксация изменений в рабочей копии
Рисунок 9 - Результат добавления картинки и фиксации изменений
Далее необходимо приступить к редактированию подготовленных заготовок фрагментов.
Рассмотрим редактирование фрагмента на примере редактирования файла overview.xml (общие сведения).
Для создания и редактирования XML-файлов используется простой текстовый редактор, способный отображать синтаксис XML-документа, и визуальный редактор XML Syntext Serna. Другое название визуальных редакторов - WYSIWYG (What You See Is What You Get) редакторы. Это означает, что содержимое отображается в процессе редактирования и выглядит максимально близко похожим на конечную продукцию, которая может быть печатным документом или веб-страницей. В Syntext Serna внешний вид документа контролируется с помощью стилей XSLT/XSL-FO.
Рисунок 10 - Результат фиксации изменений, сделанных в файле overview.xml
Добавим в главу «Общие сведения» информацию о рассматриваемой информационной системе. После добавления текста необходимо зафиксировать изменения (рисунок 10).
Аналогичным образом редактируются оставшиеся фрагменты.
После редактирования всех фрагментов также необходимо выполнить фиксацию (рисунок 11).
Рисунок 11 - Результат фиксации всех выполненных изменений