Локальные компьютерные сети
Колледж Бокситогорского института (филиала)
АОУ ВПО ленинградский государственный
университет имени А.С. Пушкина
Реферат
на тему: «Локальные компьютерные сети»
Выполнила
студентка 3 курса
специальность: Прикладная
информатика (в экономике)
Ненастьева П.Ю.
Проверил
преподаватель
Светлова О.А
Пикалево, 2014г.
СОДЕРЖАНИЕ
Введение
.Техническая документация и ее виды
2.Техническая документация: ее назначение
.Техническая документация: состав
.Техническая документация: жизненный цикл
6.Техническая документация: предпосылки к автоматизации процессов жизненного цикла
7.Состав комплекта документации
8.Формы представления технической документации
.Порядок разработки технической документации
ВВЕДЕНИЕ
На всех стадиях жизненного цикла промышленной продукции (программа/комплекс, автоматизированная система и устройство) необходима разработка документации, которая в полной мере должна обеспечить пользователя всеми необходимыми знаниями. От того насколько техническая документация будет полной, информативной и что, немаловажно правильно выполненной, зависит успех продукции на рынке.
Кроме того, разработка технической документации - важная составляющая проектной деятельности при изготовлении и внедрении программного обеспечения или автоматизированных систем. Многие компании на первоначальных стадиях создания и внедрения не придают значения необходимости разработки документации и именно это зачастую «тормозит» вывод на рынок нового продукта.
Существование любой промышленной продукции немыслимо без технической документации. Любая аппаратура, программа или система окружена документами все время: от замысла до деинсталляции или водворения на свалку. Невозможно представить себе создание хоть сколько-нибудь сложного технического решения без проектной документации, а применение без эксплуатационной. Вместе с тем, разработка технической документации требует специфических знаний и умений, а также значительных трудозатрат.
1.ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ И ЕЕ ВИДЫ
Под «технической документацией» понимается пакет документов, который используется при конструировании и (или) проектировании, эксплуатации технических объектов (промышленных сооружений, зданий, иных видов сооружений, программное и аппаратное обеспечение).
Принято считать, что техническая документация подразделяется на несколько видов:
·документация конструкторская. Она включает в себя также ремонтную и эксплуатационную документацию;
·документация технологическая. В свою очередь, она распределяется на документацию, которая содержит информацию по ремонту изделия и организации производства, и документацию с описанием технологического цикла изделия.
. ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: ЕЕ НАЗНАЧЕНИЕ
В компаниях, чья продукция может повлечь за собой гибель людей или нанесение серьезного материального ущерба, к составу и содержанию техдокументации относятся более или менее ответственно, помня о прокуроре. Таким образом, техдокументация в указанных компаниях, разрабатывается, как минимум:
·во избежание ответственности перед законом - на авиажаргоне такой подход называется «прикрытием задней полусферы»;
·для исключения возможных формальных претензий со стороны заказчика.
Указанный подход обеспечивает все предпосылки к разработке технической документации высочайшего качества.
3. ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: СОСТАВ
В серьезных компаниях, работающих на рынке автоматизированных систем, поставляемых солидным заказчикам, в состав техдокументации входят:
·техническая документация на изделия;
·техдокументация на программные изделия - программная документация.
Следует отметить, что разработка технической документации на автоматизированные системы в современных условиях неумолимо влечет за собой разработку техдокументации на изделия и программные изделия, за исключением покупных.
С другой стороны, все, что производится в современных условиях, проявляет все больше и больше признаков автоматизированных систем. Мобильный телефон, к примеру, трудно назвать изделием в классическом понимании. Вот ведро или лом - это точно изделия, и ничего больше. Тот же FineReader можно назвать программным изделием только на дистрибутивном носителе. После инсталляции FineReader начинает автоматически распознавать тексты - становится (в совокупности с программным и техническим обеспечением (средствами ПЭВМ) полноценной автоматизированной системой или системой обработки информации.
. ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: ЖИЗНЕННЫЙ ЦИКЛ
Как бы то ни было, кто бы ни занимался разработкой техдокументации, каков бы ни был ее состав, обладает техническая документация, как и все в этом мире, собственным жизненным циклом.
Жизненный цикл техдокументации включает в себя, как минимум:
·процесс разработки технической документации;
·процесс публикации техдокументации как на бумажных носителях, так и в электронном виде;
·процессы учета и хранения технической документации;
·процессы модификации, отслеживания изменений техдокументации - сопровождения;
·процесс обмена технической документацией между подразделениями компании;
·процесс передачи техдокументации заказчику (или конечному пользователю).
5.ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: ТИПИЧНАЯ РЕАЛИЗАЦИЯ ЖИЗНЕННОГО ЦИКЛА
Зрелища, молитвы, хлеб,
Бой быков и винный погреб - чем не рай?!
Бунтовать желанья нет,
Сам учил нас - «Ближнего не обижай...»
М. Пушкина
При разработке и публикации техдокументации применяются различные текстовые и графические редакторы различных версий. Пишут все. Сохраняют файлы все. Печатают все. Никакими санкциями, никакими корпоративными стандартами преодолеть склонность россиянина к анархии невозможно. Каждый пользуется тем, что привычней. Как следствие, форматы файлов, стили оформления технической документации трудно назвать единообразными и соответствующими требованиям стандартов. У каждого индивидуума свои предпочтения (в шрифтах, отступах и т.п.).
·стили заголовков с многоуровневой нумерацией - особо продвинутыми пользователями (крайне редко);
·нумерованные списки - ворд достаточно «умен» и, при попытках ручного ввода нумерации разделов иногда пытается автоматически разбить сплошной текст на разделы и подразделы в виде нумерованных списков;
·выделение строки абзацного текста жирным и ручной ввод номера раздела.
Электронная техдокументация хранится в структуре каталогов пользовательских компьютеров и серверов.
При больших объемах своевременное внесение изменений в ряд отдельных документов, отслеживание актуальных версий, архивирование старых версий технической документации невозможны. Утрачивается согласованность (непротиворечивость) техдокументации.
6.ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: ПРЕДПОСЫЛКИ К АВТОМАТИЗАЦИИ ПРОЦЕССОВ ЖИЗНЕННОГО ЦИКЛА
Каковы же предпосылки к автоматизации процессов жизненного цикла технической документации? Вот они:
·доступность специализированных средств разработки текстовых документов, построенных на основе концепции единого источника (исходника) - single source;
·замечательные особенности советской нормативно-технической документации.
Специализированных средств разработки технической (да и любой документации) навалом. Производятся таковые как отечественными компаниями, так и буржуйскими. Средства известные, на слуху, подробно останавливаться и приводить сравнительный анализ особого смысла нет.
Предпочтения автора сводятся к применению при разработке (сопровождении и т.д.) техдокументации программы AuthorIT от AuthorIT Software Corporation Ltd.
Электронная техдокументация хранится в едином централизованном хранилище - в базе данных. AuthorIT позволяет применять в качестве базы данных как MS SQL, так и отдельные файлы библиотек. А вот MySQL, увы, пока не позволяет. Библиотеки структурно подразделяются на книги, книги на разделы и подразделы, пункты и подпункты (топики) - до девяти уровней вложенности. Собственно топики и являются атомарными модулями данных. Топики (модули данных), инкапсулируя в себе содержимое разделов и подразделов книг, содержат также и служебную информацию - шаблоны разметки. Каждому модулю данных присваивается уникальный код (номер) согласно системы кодификации или название (силами пользователя).
База данных окружена оболочкой, в общем случае, включающей в себя:
·подсистему Authoring;
·подсистему Importer;
·подсистему Publisher;
·подсистему Project Manager;
·подсистему Administration.
Подсистема Authoring является средством создания, редактирования, отображения и сохранения текстов электронной техдокументации - мощным текстовым процессором. При сохранении текстов электронной технической документации подсистема автоматически формирует модули данных (согласно созданной пользователем структуры разделов документа) и сохраняет указанные модули в базе данных или в файле библиотеки.
Подсистема Importer обеспечивает возможность импорта документов из файлов различных форматов (включая *.doc и *) с сохранением структуры и содержания разделов документа во внутреннем формате AuthorIT. Есть нюансы: попытка импорта неправильно структурированного вордовского документа не пройдет. Особенно, если такой файл содержит кучу OLE-объектов (ActiveX) и сложные колонтитулы.
Подсистема Project Manager обеспечивает возможность управления проектом разработки (сопровождения и т.д.) техдокументации - организацией и назначением задач конкретным пользователям, управления продуктом в целом. Подсистема Administration обеспечивает возможность управления базой данных, управления правами пользователей.
Таким образом, AuthorIT обеспечивает возможность одновременной работы многих пользователей с библиотекой. Права и полномочия пользователей разделены на основе аутентификации и авторизации. Иными словами, изменения, внесенные в библиотеку конкретным пользователем, автоматически фиксируются с указанием имени пользователя, даты, времени и характера внесенных им изменений.
. СОСТАВ КОМПЛЕКТА ДОКУМЕНТАЦИИ
Цели и задачи документирования в каждом конкретном случае зависят, во-первых, от типа документируемого технического решения, и, во-вторых, от того, как вы с этим техническим решением собираетесь обращаться. Одно дело, если вам предстоит разработать и сдать автоматизированную систему своему заказчику, и совсем другое, если вы, наоборот, заказываете и принимаете ее у исполнителя. Одно дело, если вы разрабатываете программный комплекс и продаете его «в коробке», и совсем другое, если вы своими силами внедряете его у ваших клиентов (а если этим занимаются ваши VAR-партнеры, то третье).
Каждая из этих ситуаций обусловлена функциями, возможностями и потребностями ее участников. В том числе, возможностями сообщать и потребностями получать техническую информацию. Поэтому состав комплекта технической документации, способ ее разработки и порядок сдачи-приемки определяются тем, для чего и для кого она создается. В табл. 1 перечислены наиболее часто встречающиеся на практике типы технических решений и показано, какую документацию на них мы беремся подготовить по вашему заказу.
Таблица 1. Типы технических решений и документация на них
ТипДокументыТехнические средства- руководство по эксплуатации - руководство по техническому обслуживаниюПрограммный продукт- описание программы - руководство оператора - руководство пользователя, - руководство администратора, - руководство системного администратора - руководство программиста - описание языка - справочная системаАппаратно-программный комплекс- общее описание аппаратно-программного комплекса - инструкция по развертыванию - инструкция по эксплуатации - документация на технические средства, - документация на программное обеспечениеПлатформа или прикладное решение- общее описание программного комплекса - инструкция по развертыванию - типовые процессы - методикиПроцессы, процедуры, оргструктуры- описания процессов - регламентыСервис или автоматизированная система- концепция АС - техническое задание - документация эскизного и технического проектов - рабочая документация - формуляр - общее описание системы8.ФОРМЫ ПРЕДСТАВЛЕНИЯ ТЕХНИЧЕСКОЙ ДОКУМЕНТАЦИИ
Техническая документация может быть представлена в электронном или в печатном виде. Несмотря на широкое распространение электронных коммуникаций и устройств, в том числе, мобильных, техническая документация, отпечатанная на бумаге, уйдет в прошлое еще не скоро. Во-первых, сильна инерция, во-вторых, в ряде ситуаций книга объективно более удобна и надежна.
Единицы или даже десятки экземпляров документа могут быть изготовлены с помощью офисной техники, для сотенных тиражей больше подходит цифровая печать, для тысячных - старые-добрые типографские технологии вроде офсетной печати. Но в любом случае твердая копия сегодня создается на основе электронного документа в том или ином формате. Одни из них ориентированы исключительно на печать, другие на чтение с экрана, третьи позволяют с большим или меньшим удобством использовать документ обоими способами. Среди экранных форматов особое место занимают форматы для размещения документации в Интернете или в локальной сети.
В настоящее время существует много разных форматов электронной документации. Некоторые из них ориентированы на представление отдельных документов, другие позволяют предоставить пользователю доступ к более крупными объемам знаний: сборникам документов, библиотекам, энциклопедиям. Подробное описание всех доступных сегодня форматов потребовало бы создания подробной монографии. В табл. 2 представлены некоторые наиболее популярные форматы электронной документации.
Таблица 2. Форматы электронной документации
Тип документаНазначениеФорматыЛинейные документыВывод на печатьPDF простой; Microsoft WordЛинейные документы с элементами гипертекстаВывод на печать; Чтение с экранаPDF с элементами гипертекста (активное оглавление, перекрестные ссылки, закладки); HTML-файлСправочные системы для приложений на платформе Microsoft WindowsКонтекстная справка, интегрированная в приложение; Электронные книги и справочники для чтения с экранаWinHelp (hlp); HTML Help (chm)Справочные системы для Java-приложенийКонтекстная справка, интегрированная в приложениеJavaHelpЭлектронные публикацииКонтекстная справка, интегрированная в веб-приложение;