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

Цели и задачи документирования. Техническая документация, ее виды, назначение и формы представления. Предпосылки к автоматизации процессов жизненного цикла документации. Состав комплекта документации. Порядок разработки электронной техдокументации.
Краткое сожержание материала:

Размещено на

Размещено на

Колледж Бокситогорского института (филиала)

АОУ ВПО ленинградский государственный

университет имени А.С. Пушкина

Реферат

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

Выполнила

студентка 3 курса

специальность: Прикладная

информатика (в экономике)

Ненастьева П.Ю.

Проверил

преподаватель

Светлова О.А

Пикалево, 2014г.

СОДЕРЖАНИЕ

Введение

1. Техническая документация и ее виды

2. Техническая документация: ее назначение

3. Техническая документация: состав

4. Техническая документация: жизненный цикл

5. Техническая документация: типичная реализация жизненного цикла

6. Техническая документация: предпосылки к автоматизации процессов жизненного цикла

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

8. Формы представления технической документации

9. Порядок разработки технической документации

ВВЕДЕНИЕ

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

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

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

1. ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ И ЕЕ ВИДЫ

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

Принято считать, что техническая документация подразделяется на несколько видов:

· документация конструкторская. Она включает в себя также ремонтную и эксплуатационную документацию;

· документация технологическая. В свою очередь, она распределяется на документацию, которая содержит информацию по ремонту изделия и организации производства, и документацию с описанием технологического цикла изделия.

2. ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: ЕЕ НАЗНАЧЕНИЕ

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

· во избежание ответственности перед законом - на авиажаргоне такой подход называется «прикрытием задней полусферы»;

· для исключения возможных формальных претензий со стороны заказчика.

Указанный подход обеспечивает все предпосылки к разработке технической документации высочайшего качества.

3. ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: СОСТАВ

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

· техническая документация на автоматизированные системы;

· техническая документация на изделия;

· техдокументация на программные изделия - программная документация.

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

С другой стороны, все, что производится в современных условиях, проявляет все больше и больше признаков автоматизированных систем. Мобильный телефон, к примеру, трудно назвать изделием в классическом понимании. Вот ведро или лом - это точно изделия, и ничего больше. Тот же FineReader можно назвать программным изделием только на дистрибутивном носителе. После инсталляции FineReader начинает автоматически распознавать тексты - становится (в совокупности с программным и техническим обеспечением (средствами ПЭВМ) полноценной автоматизированной системой или системой обработки информации.

4. ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: ЖИЗНЕННЫЙ ЦИКЛ

Как бы то ни было, кто бы ни занимался разработкой техдокументации, каков бы ни был ее состав, обладает техническая документация, как и все в этом мире, собственным жизненным циклом.

Жизненный цикл техдокументации включает в себя, как минимум:

· процесс разработки технической документации;

· процесс публикации техдокументации как на бумажных носителях, так и в электронном виде;

· процессы учета и хранения технической документации;

· процессы модификации, отслеживания изменений техдокументации - сопровождения;

· процесс обмена технической документацией между подразделениями компании;

· процесс передачи техдокументации заказчику (или конечному пользователю).

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

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

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

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

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

М. Пушкина

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

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

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

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

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

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

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

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

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

· доступность специализированных средств разработки текстовых документов, построенных на основе концепции единого источника (исходника) - single source;

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

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

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

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