Локальные компьютерные сети

Зрелища, молитвы, хлеб,

Бой быков и винный погреб - чем не рай?!

Бунтовать желанья нет,

Сам учил нас - «Ближнего не обижай...»

М. Пушкина

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

Еще одна общая беда - электронная техническая документация не структурируется должным образом. Для разбиения электронной техдокументации на разделы (подразделы, пункты, подпункты) применяются:

· стили заголовков с многоуровневой нумерацией - особо продвинутыми пользователями (крайне редко);

· нумерованные списки - ворд достаточно «умен» и, при попытках ручного ввода нумерации разделов иногда пытается автоматически разбить сплошной текст на разделы и подразделы в виде нумерованных списков;

· выделение строки абзацного текста жирным и ручной ввод номера раздела.

Электронная техдокументация хранится в структуре каталогов пользовательских компьютеров и серверов.

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

6. ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: ПРЕДПОСЫЛКИ К АВТОМАТИЗАЦИИ ПРОЦЕССОВ ЖИЗНЕННОГО ЦИКЛА

Каковы же предпосылки к автоматизации процессов жизненного цикла технической документации? Вот они:

Предпочтения автора сводятся к применению при разработке (сопровождении и т.д.) техдокументации программы AuthorIT от AuthorIT Software Corporation Ltd.

Электронная техдокументация хранится в едином централизованном хранилище - в базе данных. AuthorIT позволяет применять в качестве базы данных как MS SQL, так и отдельные файлы библиотек. А вот MySQL, увы, пока не позволяет. Библиотеки структурно подразделяются на книги, книги на разделы и подразделы, пункты и подпункты (топики) - до девяти уровней вложенности. Собственно топики и являются атомарными модулями данных. Топики (модули данных), инкапсулируя в себе содержимое разделов и подразделов книг, содержат также и служебную информацию - шаблоны разметки. Каждому модулю данных присваивается уникальный код (номер) согласно системы кодификации или название (силами пользователя).

База данных окружена оболочкой, в общем случае, включающей в себя:

Подсистема Importer обеспечивает возможность импорта документов из файлов различных форматов (включая *.doc и *) с сохранением структуры и содержания разделов документа во внутреннем формате AuthorIT. Есть нюансы: попытка импорта неправильно структурированного вордовского документа не пройдет. Особенно, если такой файл содержит кучу OLE-объектов (ActiveX) и сложные колонтитулы.

Подсистема Publisher обеспечивает возможность сборки документов из модулей данных внутреннего формата AuthorIT, публикации технической документации в различных форматах help-файлов, а также в формате MSWord. Вордовые файлы получаются замечательными - никаких проблем с кириллицей и т.п. Важно только настроить шаблон - это просто.

Цели и задачи документирования в каждом конкретном случае зависят, во-первых, от типа документируемого технического решения, и, во-вторых, от того, как вы с этим техническим решением собираетесь обращаться. Одно дело, если вам предстоит разработать и сдать автоматизированную систему своему заказчику, и совсем другое, если вы, наоборот, заказываете и принимаете ее у исполнителя. Одно дело, если вы разрабатываете программный комплекс и продаете его «в коробке», и совсем другое, если вы своими силами внедряете его у ваших клиентов (а если этим занимаются ваши VAR-партнеры, то третье).

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

Таблица 1. Типы технических решений и документация на них

8. ФОРМЫ ПРЕДСТАВЛЕНИЯ ТЕХНИЧЕСКОЙ ДОКУМЕНТАЦИИ

Техническая документация может быть представлена в электронном или в печатном виде. Несмотря на широкое распространение электронных коммуникаций и устройств, в том числе, мобильных, техническая документация, отпечатанная на бумаге, уйдет в прошлое еще не скоро. Во-первых, сильна инерция, во-вторых, в ряде ситуаций книга объективно более удобна и надежна.

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

В настоящее время существует много разных форматов электронной документации. Некоторые из них ориентированы на представление отдельных документов, другие позволяют предоставить пользователю доступ к более крупными объемам знаний: сборникам документов, библиотекам, энциклопедиям. Подробное описание всех доступных сегодня форматов потребовало бы создания подробной монографии. В табл. 2 представлены некоторые наиболее популярные форматы электронной документации.

Таблица 2. Форматы электронной документации

Выбор удачного формата для каждого из документов -- не менее важное и ответственное решение, чем формирование состава комплекта документации или структуры документа.

электронный документация жизненный цикл

9. ПОРЯДОК РАЗРАБОТКИ ТЕХНИЧЕСКОЙ ДОКУМЕНТАЦИИ

Комплект технической документации может быть разработан как «с чистого листа», так и на основе предоставленных материалов: документации предыдущих этапов проекта, документации на ранние версии программы или системы и т. п.

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

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

Цикл разработки комплекта технической документации включает в себя следующие основные этапы:

· Уточнение целей и задач работы.

· Изучение предмета документирования.

· Формирование требований к документации.

· Составление текста документации.

· Согласование документации.

· Формирование документов в нужных форматах.

· Поставка комплекта документации заказчику.

Размещено на Allbest.ur