WWW.LIB.KNIGI-X.RU
БЕСПЛАТНАЯ  ИНТЕРНЕТ  БИБЛИОТЕКА - Электронные матриалы
 


«Промышленные технологии проектирования ПО Документирование программного обеспечения Документирование Виды документации Проектная документация ...»

Промышленные технологии

проектирования ПО

Документирование программного

обеспечения

Документирование

Виды документации

Проектная документация

Программная документация

Эксплутационная документация

Рабочая документация (*)

Ицыксон В.М. ПТППО (С) 2010

Проектная документация

Должна создаваться в начале проекта и

модифицироваться по мере продвижения проекта

Стандарты:

ГОСТ 19.201-78 ЕСПД.

Техническое задание.

Требования к содержанию и оформлению.

ГОСТ 34.602-89 Информационная технология.

Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы ГОСТ 19.301-79 ЕСПД. Программа и методика испытаний. Требования к содержанию и оформлению.

Ицыксон В.М. ПТППО (С) 2010 Программная документация Должна создаваться в одновременно с реализацией проекта и модифицироваться процессе эволюции проекта

Стандарты:

ГОСТ 19.202-78 ЕСПД.

Спецификация. Требования к содержанию и оформлению.

ГОСТ 19.401-78 ЕСПД.

Текст программы Требования к содержанию и оформлению ГОСТ 19.402-78 ЕСПД. Описание программы.

ГОСТ 19.504-79 ЕСПД.

Руководство программиста.

Требования к содержанию и оформлению ГОСТ 19.701-90 (ИСО 5807-85) ЕСПД. Схемы алгоритмов, программ, данных и систем. Обозначения условные и правила выполнения. (Вместо ГОСТ 19.002-80, ГОСТ 19.003-80) Ицыксон В.М. ПТППО (С) 2010 Эксплутационная документация Должна создаваться по окончании проекта

Стандарты:

ГОСТ 19.505-79 ЕСПД.

Руководство оператора.

Требования к содержанию и оформлению.

ГОСТ 19.508-79 ЕСПД.

Руководство по техническому обслуживанию. Требования к содержанию и оформлению.

ГОСТ 19.503-79 ЕСПД.

Руководство системного программиста. Требования к содержанию и оформлению Ицыксон В.М. ПТППО (С) 2010 Рабочая документация Документация, отражающая текущее состояние проекта Рабочая документация подчиняется только корпоративным стандартам документирования Рабочая документация должна изменяться вместе с проектом Рабочая документация должна версионироваться вместе с проектом На стадии выпуска рабочая документация может стать программной документацией или эксплутационной документацией Обычной практикой является электронное ведение рабочей документации Ицыксон В.М. ПТППО (С) 2010 Рабочая документация Вариант ведения электронной документации - портал проекта Разделяемое дисковое пространство Группы новостей Списки рассылки Wiki Коммерческие системы организации совместной работы MS Sharepoint IBM Lotus И т.п.

Ицыксон В.М. ПТППО (С) 2010 Изобразительные средства документации Текстовая документация Графическая документация Схемы программ Схемы алгоритмов Схемы данных UML-диаграммы И т.п.

Динамическая документация (*)

–  –  –

Ицыксон В.М. ПТППО (С) 2010 Генерация документации Впервые предложил Д. Кнут – язык WEB Концепция «грамотного» программирования Объединения текста и документации Один компилятор для получения объектного кода Второй компилятор для получения документации Сейчас основной подход – аннотирование текста программы с помощью структурированных комментариев Описание модулей Описание функций, классов Описание переменных Описание параметров функций и методов И т.п.

Ицыксон В.М.

ПТППО (С) 2010 Генерация документации На основании аннотаций и текста программы генерируется система документов:

html – страницы Документ Word, rtf Документ PDF Документы XML Используется при подготовке программной документации Описание программы Руководство программиста Ицыксон В.М. ПТППО (С) 2010 Генерация документации Генераторы документации Javadoc http://java.sun.com/j2se/javadoc/ Cppdoc http://www.cppdoc.com/ Pasdoc http://sourceforge.net/projects/pasdoc/ Cdoc http://www.annexia.org/freeware/cdoc

Многоязыковые:

Doxygen http://www.doxygen.org/ Ицыксон В.М. ПТППО (С) 2010 Генерация документации. Пример аннотации в стиле JavaDoc /** * Проверяет, допустимый ли ход.

* Например, чтобы задать ход e2-e4, напишите isValidMove(5,2,5,4);

* @author John Doe * @param theFromFile Вертикаль, на которой находится фигура (1=a, 8=h) * @param theFromRank Горизонталь, на которой находится фигура (1...8) * @param theToFile Вертикаль клетки, на которую выполняется ход (1=a, 8=h) * @param theToRank Горизонталь клетки, на которую выполняется ход (1...8) * @return true, если ход допустим, и false, если недопустим */ boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank) {...

} Ицыксон В.М. ПТППО (С) 2010 Промышленные технологии документирования Использование структурированных форматов хранения документации Отделение семантики от форматирования Генерация многих видов документов из одной основы:

Генерация программной документации (HTML, PDF, ODF, Word) Генерация эксплутационной документации (HTML, PDF, ODF, Word) Интерактивные системы помощи (help) И т.п.

Ицыксон В.М. ПТППО (С) 2010 Промышленные технологии документирования Коммерческие системы AuthorIT Adobe Framemaker Свободно-распространяемые системы LaTeX DocBook DITA Ицыксон В.М. ПТППО (С) 2010 Система LaTeX Набор макрорасширений для TeX Используется система тэгов для форматирования документов Поддерживается экспорт во все популярные форматы Ицыксон В.М. ПТППО (С) 2010 Пример форматирования LaTeX \documentclass[12pt]{article} % Вот это комментарий, он не будет показан в выходном файле.

\usepackage[russian]{babel} % Включаем пакет для поддержки русского языка.

\title{\LaTeX} \date{} \author{} \begin{document} \maketitle \LaTeX{} "--- это своего рода препроцессор текста для \TeX{} "--- программы компьютерной вёрстки. \LaTeX{} является программируемым и расширяемым, что позволяет автоматизировать большую часть аспектов набора, включая нумерацию, перекрёстные ссылки, таблицы и изображения (их размещение и подписи к ним), общий вид страницы, библиографию и многое-многое другое.

\LaTeX{} был первоначально написан Лэсли Лампортом в 1984-м году и стал наиболее популярным способом использования \TeX{}а; очень мало людей сегодня пишут на оригинальном \TeX{}е. Текущей версией является \LaTeXe.

\newline \begin{eqnarray} E &=& mc^2\\ m &=& \frac{m_0}{\sqrt{1-\frac{v^2}{c^2}}} \end{eqnarray} \end{document} Ицыксон В.М. ПТППО (С) 2010 DITA Darwin Information Typing Architecture Представлена IBM OASIS: DITA 1.0, 2005 г.

http://www.oasisopen.org/committees/dita XML–документы и DTD-темы Охватывает весь цикл разработки, выпуска технической документации Ицыксон В.М. ПТППО (С) 2010 DocBook Текущая версия DocBook 5.0 Стандарт OASIS: DocBook 4.4, 2005 г.

www.docbook.org Набор XML-тэгов, структурирующих элементы документации Регламентируется XML-схемой DocBook предоставляет более 400 тэгов Независимость содержания от представления Принцип единого источника Легко конвертируется в любой формат Существуют DocBook-редакторы и фильтры для популярных текстовых процессоров Ицыксон В.М. ПТППО (С) 2010 Пример документа DocBook variablelisttitleВходы пакета pk_name/title varlistentry termname_short(a_name)/term listitemparaПринимает необработанное название и возвращает его systemitemкраткую форму нормализованного названия/systemitem.

/para/listitem /varlistentry varlistentry termname_trans(a_name)/term listitemparaПринимает systemitemполную форму нормализованного названия/systemitem и возвращает systemitemкраткую форму нормализованного названия/systemitem.

/para/listitem /varlistentry varlistentry termname_full(a_name)/term listitemparaПринимает необработанное название и возвращает его systemitemполную форму нормализованного названия/systemitem.

/para/listitem /varlistentry /variablelist

Похожие работы:

«Министерство образования и науки Российской Федерации федеральное государственное автономное образовательное учреждение высшего образования "НАЦИОНАЛЬНЫЙ ИССЛЕДОВАТЕЛЬСКИЙ ТОМСКИЙ ПОЛИТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ" Институт природных ресурсов Кафедра "Геологии и разведки полезных ископаемых" Специальность: 130304 "Геология неф...»

«Леонтьева Елена Геннадьевна ИНТЕРНАЦИОНАЛИЗАЦИЯ УНИВЕРСИТЕТСКОГО ОБРАЗОВАНИЯ: СОЦИАЛЬНО – ФИЛОСОФСКИЙ АНАЛИЗ 09.00.11 – социальная философия Автореферат диссертации на соискание ученой степени кандидата философских наук Томск 2001 Работа выполнена на кафедре международного менеджмента Томского политехнического универси...»

«Московский государственный технический университет имени. Н. Э. Баумана Центр довузовской подготовки Шаг в будущее, Москва Сборник лучших работ Научно-образовательное соревнование "Шаг в будущее, Москва" УДК 004, 005, 51, 53, 62 ББК 22, 30, 31, 32, 34 Сборник трудов "Лучшие науч...»

«HIRSCHMANN Инструкция по эксплуатации Установка Industrial ETHERNET Rail коммутаторов Семейства RS20/RS30 RS20 с 24 RS20 с 8 RS20 с 4 портами портами портами RS30 с 26 RS30 с 10 портами портами RS20/RS30 Release 1.0 09/05 Соответствие описанных в данном руководстве технических...»

«Регламент выдачи технических условий на подключение (технологическое присоединение) объектов капитального строительства к электрическим сетям ГУП РК "Крымэнерго" Термины и определения, важные для осуществления технологического присоеди...»

«УРАЛЬСКИЙ ГОСУДАРСТВЕННЫЙ ЛЕСОТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ Чернов Н.Н.ВОПРОСЫ МЕТОДОЛОГИИ ЛЕСОВЕДЕНИЯ Екатеринбург 2015 УДК 630.2.: 167 ББК 43. 4 Чернов Н.Н. Вопросы методологии лесоведения / Уральский госуда...»

«База нормативной документации: www.complexdoc.ru ГОСТ Р 52107-2003 НАЦИОНАЛЬНЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИ РЕСУРСОСБЕРЕЖЕНИЕ КЛАССИФИКАЦИЯ И ОПРЕДЕЛЕНИЕ ПОКАЗАТЕЛЕЙ ГОССТАНДАРТ РОССИИ Москва Предисловие 1 РА...»

«ООО "НПФ РУСАВТОДОР" Шифр темы – ДДХ/2009/1 ПРОЕКТ УТВЕРЖДЕН Постановлением Правительства Российской Федерации от № Технический регламент "О требованиях к обеспечению безопасности автомобильных дорог при их эксплуатации" I. Общие положения 1.Нас...»

«УДК 330.341.2-021.331 А.А. Зарнадзе. ИНСТИТУЦИОНАЛЬНАЯ ПАРАДИГМА УПРАВЛЕНИЯ Аннотация. Работа посвящается краткому изложению новой концепции управления народным хозяйством под названием "институциональная парадигма управления". Показана взаи...»








 
2017 www.lib.knigi-x.ru - «Бесплатная электронная библиотека - электронные матриалы»

Материалы этого сайта размещены для ознакомления, все права принадлежат их авторам.
Если Вы не согласны с тем, что Ваш материал размещён на этом сайте, пожалуйста, напишите нам, мы в течении 1-2 рабочих дней удалим его.