Документирането на софтуер

13.1. Документация създадени и използвани в процеса на разработка на софтуер

При проектирането на СС е създаден и се използва голямо количество различни документация. Необходимо е като средство за предаване на информация между разработчиците на СС като контрол на развитие означава, PS и като средство за предаване на информация на потребителите, необходима за прилагането и поддържането на подстанции. Създаването на тази документация представлява голям дял от разходите на подстанцията.







Тази документация могат да бъдат разделени в две групи [13.1]

  • Управление на Документи подстанция развитие.
  • Документи, включени в подстанцията.

Документи за управление на развитието PS (документация на софтуер процес) се контролират и записват на процесите на разработка и поддръжка на подстанции, осигуряване на комуникация в екипа за развитие и СС между екипа за развитие и ръководителите на СС (софтуерни мениджъри) - лица, които контролират развитието на MS. Тези документи могат да бъдат следните видове [13.1]

  • Планове, оценки, графици. Тези документи са създадени от мениджърите да прогнозират и да контролират процесите на развитие и поддържане на подстанции.
  • Доклади за използване на ресурсите в процеса на развитие. Създаден от мениджъри.
  • Стандарти. Тези документи се нуждаят от разработчиците как принципите, правилата, споразумения, те трябва да следват в процеса на развитие на СС. Тези стандарти могат да бъдат или международни или национални, както и специално създадени за организацията, която се развива СС.
  • Работни документи. Това са основните технически документи, които осигуряват връзка между разработчиците. Те съдържат фиксирането на идеи и проблеми, които възникват в процеса на развитие, описание на използваните стратегии и подходи, както и на работниците (временни) версии на документите, които трябва да бъдат включени в електроенергийната система.
  • Бележки и кореспонденция. Тези документи записват различните детайли на взаимодействието между мениджъри и предприемачи.

    Документите, които са част от (документация на продукта софтуер) на електроенергийната система. опишете програмата на СС, както по отношение на своите потребители за кандидатстване и по отношение на тяхното развитие и компаньонки (в съответствие с целите на СС). Трябва да се отбележи, че тези документи ще бъдат използвани не само на етапа на експлоатация на СС (в своите фази на прилагане и поддържане), но също така в процес на разработване на процеса на разработване на управление (включително работни документи) - във всеки случай, те трябва да бъдат проверени (тестван ) за съответствие с програмата на електроенергийната система. Тези документи се образуват двата набора с различно предназначение:

  • документация за потребителя за PS (P-документация).
  • Документация в подкрепа на СС (C-документация).

    13 0.2. софтуер документация за потребителя

    Потребителят документация за PS (потребителска документация) обяснява на потребителите как да действат, за да се прилагат разработена от PS [13.1, 13.2.]. Необходимо е, ако PS приема всяко взаимодействие с потребителя. Това включва документ, който трябва да се ръководи от потребителя по време на инсталацията на PS (при инсталиране на PS към подходящата настройка за използване среда на СС), прилагането на СС за решаването на задачите си и в управлението на СС (например, когато той развива ПС ще си взаимодейства с други системи). Тези документи са частично засегнати въпроси по поддръжката на подстанцията, но не решаване на въпросите, свързани с изменението на програмата.

    документация Състав на потребителя зависи от аудиторията на потребителите, която е ориентирана разработен от СС, и начина на употреба на документите. По аудитория тук се отнася до контингент от потребители PS, които имат нужда от специфична потребителска документация за PS [13.2]. Успешно хартия по избор по същество зависи от точното определение на публиката, за която е предназначена. Документацията на потребителя трябва да съдържа информацията, необходима за всяка аудитория. При начина на използване на документа се отнася до метод, който определя как се използва този документ. Обикновено, потребителят има само големи софтуерни системи изискват никакви документи за изучаване на PS (използвайте като ръководство) или за да актуализира някои от данните (използвайте като ръководство).







    В съответствие с [13.1, 13.2], може да се счита за типичен част от следващата употреба документацията за достатъчно голям SS:

  • Обща функционално описание на MS. Тя дава кратко описание на функционалните възможности на СС. Предназначена е за потребители, които се нуждаят, за да решите колко имате нужда от тях, тази подстанция.
  • за монтаж PS лидерство. Предназначен за мениджъри PS. Той се предписва по-подробно как се инсталира на системата в определена среда, по-специално, трябва да включва описание на електронен носител, на който се доставя PS файлове, представляващи СС, и на изискванията за минимална хардуерна конфигурация.
  • Инструкции за употреба SS. Предназначен за обикновените потребители. Той съдържа необходимата информация за прилагането на СС, организирана под формата удобно за неговото изследване.
  • Референтен SS кандидатстване. Тя предназначена за обикновените потребители. Той съдържа необходимата информация за прилагането на СС, организирана под формата на лесни за селективно търсене на отделните части.
  • Ръководство за управление на FP. Предназначен за мениджъри PS. Тя трябва да описва съобщенията, генерирани, когато държавите-членки си взаимодейства с други системи, както и как да се реагира на тези доклади, администратора. Освен това, ако СС използва хардуера на системата, този документ може да се обясни как да се поддържа това оборудване.

    Документация софтуерна поддръжка

    Документация в подкрепа на СС (документация за системата) описва подстанцията от гледна точка на нейното развитие. Тази документация се изисква, ако подстанцията включва изучаването на това как тя е подредена (проектиран), както и модернизацията на своите програми. Както вече бе отбелязано, подкрепата - това е непрекъснато развитие. Ето защо, в случай на необходимост от модернизация на СС за тази работа специален екип от ескорт разработчици. Този екип ще трябва да се справят с една и съща документация, която определя дейността на екипа на първоначалните (основни) разработчиците подстанции - единствената разлика е, че документацията за разработчиците на командния ескорт ще са склонни странно (тя е създадена от друг отбор). За да се разбере структурата и процеса на развитие на модернизирани подстанциите, тийм-ескорт разработчиците трябва да учат на документацията, а след това направи необходимите промени, повтаряйки до голяма степен от процесите, които са създали оригинални ДЧ.

    документация подкрепа FP могат да бъдат разделени на две групи:

  • документация, която определя структурата на програмите и структурите от данни и технологично развитие PS;
  • документация, за да направи промени в подстанцията.

    първата група от записи, съдържащи окончателните документи на всеки процес на развитие стъпка PS. Тя включва следните документи:

  • Външен вид PS (Изисквания документ).
  • Архитектура Описание PS (описание на архитектурата на системата), всеки, включително външен спецификация на своята програма (подсистема).
  • За всяка програма, СС - описание на модулната си конструкция, включително външната спецификация на всеки модул са включени в него.
  • За всеки модул - спецификации и описание на структурата (описание дизайн).
  • модули Текстове, по избрания език за програмиране (изходния код на програмата обяви).
  • Документи за установяване на достоверността на документите (валидиране) на СС, описващи как да се установи истинността на всяка програма подстанция и как информацията за създаване на доверие е свързано с изискванията на СС.

    Документи за установяване на достоверността на СС включват, преди всичко, на документацията за тестване (изпитване и описание на тестове настроен верига), но могат да включват други видове инспекция на СС, например, доказателството за програмни свойства. За да се осигури приемливо качество на документацията полезно да се следват общоприетите насоки и стандарти [13.3 - 13.8].

    Документацията на втората група съдържа

  • в подкрепа на ръководството на SS (система за употреба поддръжка), която описва характеристиките на изпълнението на СС (по-специално, за трудностите, които е трябвало да бъдат преодолени) и как да се вземат под внимание възможността за развитието на МС в своята структура (дизайна). Той също така фиксиран, кои части са хардуерно PS и хардуер зависими.

    Често срещан проблем, придружаващ СС - да гарантира, че всичките му идеи се бавят (остават постоянни) При промяна на МС. За да помогне на този, на комуникацията и отношенията между документите и техните части трябва да бъдат отразени в инструкцията за поддръжка и в базата данни за управление на конфигурацията.

    Упражнения за лекциите 13

    13.1. Какво е управител на софтуерен инструмент?

    13.2. Какво е най-обикновен потребител софтуерен инструмент?

    13.3. Какво представлява инструментът за администратор софтуер?

    13.4. Какво е ръководството да installyatsiiprogrammnogo средства?

    13.5. Какво е ръководството да upravleniyuprogrammnym средства?

    13.6. Какво е лидерство в подкрепа на софтуерни инструменти?

    Литература Лекция 13

    Знаете ли, че на диаграма внедряване, прилагане чарт, поставяне на схема за разполагане Диаграма - метод за обектно-ориентиран дизайн, показващ връзката между физическата хардуерни и софтуерни компоненти на системата.

    Новини
    Knights етер теория