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

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

 

 

 

 

 

 

 

 

 

 

 

 

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

 

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

 

 

 

 

 

 

 

 

 

 

 

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

 

 

 

 

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

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

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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

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

Тип документа	Назначение	Форматы
Линейные документы	Вывод на печать	PDF простой; Microsoft Word
Линейные документы с элементами гипертекста	Вывод на печать; Чтение с экрана	PDF с элементами гипертекста (активное  оглавление, перекрестные ссылки, закладки); HTML-файл
Справочные системы для приложений на платформе Microsoft Windows	Контекстная справка, интегрированная в приложение; Электронные книги и справочники для чтения с экрана	WinHelp (hlp); HTML Help (chm)
Справочные системы для Java-приложений	Контекстная справка, интегрированная в приложение	JavaHelp
Электронные публикации	Контекстная справка, интегрированная в веб-приложение; Размещение электронной документации в Интернете или в интранет-сети	WebHelp; каталог HTML-файлов
Электронные библиотеки и энциклопедии	Создание единого корпоративного архива технической документации; Постоянное пополнение и обновление документации разработчиками	Конфигурационная база данных; Wiki

 

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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

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

 

 

 

 

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

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

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

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

• Уточнение целей и задач работы.
• Изучение предмета документирования.
• Формирование требований к документации.
• Составление текста документации.
• Согласование документации.
• Формирование документов в нужных форматах.
• Поставка комплекта документации заказчику.

 

 

 

СПИСОК ЛИТЕРАТУРЫ

 

 

1. http://rusertifikat.ru/catalog/nashi-uslugi/prochie-uslugi/razrabotka-tehnicheskoy-dokumentatsii/
2. http://www.philosoft.ru/docsdev.zhtml
3. http://yandex.ru/clck/jsredir?from=yandex.ru%3Byandsearch%3Bweb%3B%3B%2Fweb%2Fitem%2Ftitle%2Cpos%2Cp1%2Csource%2Cweb_tdi%2Cpost%2Cadresa&text=%D1%80%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0%20%D1%82%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D0%B8&uuid=&state=AiuY0DBWFJ4ePaEse6rgeAjgs2pI3DW99KUdgowt9XvoT-twMUKrgJKJDs1XMgCGrkFIHVZiWbT1GZvKXJjDEFUb667LxDj2recOSpGVZ7jbvfYXlC4xezFyKdKRpG1rlTMROZyicz5QUh-RZHxD1Wo51GVK5KvBQSGlu9GtRdOXoa-WZPO-Suvuv7qHgA4fnZFkgEanlzAj13uUAofrP9sw9tZ1NBId_gDp16lWxUBDe24Lkg6tAQ&data=UlNrNmk5WktYejR0eWJFYk1Ldmtxa3B1NFVNSG1idEIyVjdRQ0VwSmF2dno4Y0lRalM3NDlLeUZUSmdTYnpJdHhoeThiQnRDWnBxTkNUb1pFMlQ0REZGM2F2MnZlclZa&b64e=2&sign=cd536c0479b818e1f8069dfb7470e9ce&keyno=0&l10n=ru&mc=3.238901256602631
4. http://yandex.ru/clck/jsredir?from=yandex.ru%3Byandsearch%3Bweb%3B%3B%2Fweb%2Fitem%2Ftitle%2Cpos%2Cp3%2Csource%2Cweb&text=%D1%80%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0%20%D1%82%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D0%B8&uuid=&state=AiuY0DBWFJ4ePaEse6rgeAjgs2pI3DW99KUdgowt9Xsh9AmfW_e8fw8JjxSfq9kqDJAq_FkPlhAp7OD1uXI4aokPR6ze4BekS2C0SrXIbdrHBpaRqmdOyAEIGUWvTmm8bWPKKlEkeslDWhqHu1iEeoqmFI0U_6VeziVBhXw8dqGRTrUw_jX57DcccaQDO4emkHluVBwzWAQaQA1dmreJW86FD8SbKVT0gpuEW3nWn50&data=UlNrNmk5WktYejR0eWJFYk1LdmtxbDhsYXVwY0tzS0VGU1ZCdVljRENGVHRobUExNWR3cVpUX0QwTnRCVTQzTkZjeEhJS21nTjY0dzFfdEZkcFI3VEk1RC1CMU9xdy1s&b64e=2&sign=9d8f5cea034d65a12098709a0a6e8ea7&keyno=0&l10n=ru&mc=3.1556390622295662