План за разработка на …
|
Документ #
|
Версия: 01
|
Страница /
|
Thank-you for downloading the
All In One Template!
More templates to download on the:
Templates Repository for Software Development Process (click here)
Or paste the link below in your browser address bar:
http://blog.cm-dm.com/pages/Software-Development-Process-templates
This work is licensed under the:
Creative Commons Attribution-NonCommercial-NoDerivs 3.0 France License: http://creativecommons.org/licenses/by-nc-nd/3.0/fr/
Waiver:
You can freely download and fill the templates of blog.cm-dm.com, to produce technical documentation. The documents produced by filling the templates are outside the scope of the license. However, the modification of templates to produce new templates is in the scope of the license and is not allowed by this license.
To be compliant with the license, I suggest you to keep the following sentence at least once in the templates you store, or use, or distribute:
This Template is the property of Cyrille Michaud License terms: see http://blog.cm-dm.com/post/2011/11/04/License
Who am I? See my linkedin profile:
http://fr.linkedin.com/pub/cyrille-michaud/0/75/8b5
You can remove this first page when you’ve read it and acknowledged it!
Съдържание
1 Въведение 3
2 Управление на проекта 5
3 Спецификацияя 7
4 Архитектура на системата 10
5 Верификация 11
6 Резултати от тестоветес 13
7 Проследимост на изискванията 14
1Въведение
Въведение:
Този шаблон е комбиниран, опростен план за разработка на софтуер.
Този шаблон НЕ включва управление на риска.
Той се попълва постоянно по време на разработката на проекта.
Препоръчваме да увеличавате версията на документа, когато запълните цяла секция. Например::
-
Версия1: част 1 & 2
-
Версия2: част 3 & 4
-
Версия3: част 5
-
Версия4: част 6
Част 7 се попълва по време на версии 1 и 2.
1.1Описание на документа
Този документ описва организацията, спецификация, концепцията на проекта, както и тестовете, които се изпълняват за гарантиране на очакваният резултат, а именно изпълнението на следните цели:
1.2Обхват на проекта 1.2.1Identification
This document applies to the XXX device(s) developed in the XXX project.
1.2.2Кратко описание
Кратко описание на проекта
1.3Речник на термините и използвани съкращения 1.3.1Съкращения
Добавете съкращенията тук
1.3.2Речник на термините
Добавете речник на термините
1.4Свързани документи 1.4.1Към други проектни документи
#
|
Документ №
|
Заглавие на документа
|
[R1]
|
ID
|
Add your documents references.
One line per document
|
1.4.2Към стандарти и изисквания за съответствие
#
|
Документ №
|
Заглавие на документа
|
[STD1]
|
|
Add your references
|
1.5Конвенции
Изискванията в този документ са зададени използвайки следната структура:
Идентификатор на изискването
Заглавие на изискването
Описание на изискването
Верси на изискването
Например:
SRS-XXX-000
Заглавие на XXX-000
Описание на XXX-000
Version 1.0
Конвенция за използваните шрифтове.
Други конвенции.
2Управление на проекта
Тази секция описва управлението на проекта и организационна структура на екипа.
2.1Описание на екипа
Структурата на екипа е описана във диаграмата по-долу.
Добавете диаграма на организацията
2.2Отговорности
Следва описание на ролите в отговорностите на длъжностите в екипа::
-
Технически мениджър: XXX
-
Мениджър проект: XXX
-
Ръководител екип:
-
Програмист:
-
XXX
2.3Участие на клиента в проекта
Опишете как клиента участва в процеса на разработката на проекта: срещи, рецензии, презентиране на междинни версии, одитиране и валидация/приемане на свършената работа.
Клиента може да НЕ Е крайният потребител.
2.4Задачи – Планиране – Важни етапи от разработката
Планът по-долу съдържа всички задачи свързани с изпълнението на проекта, както и връзката между тях. Завържването на определен набор от задачи маркира специфични етапи от разработката на проекта, които подлежат на валидиране.
Insert a table or list or diagram describing the planning.
2.5Инструменти за разработка
Какви работни станции, сървъри са нужни за разработката, както и всички останали хардуерни устройства.
2.6Други необходими ресурси
Ако съществуват други необходими ресурси – като специални инструменти, симулатори .. и др, то те трябва да се идентифицират и опишат..
В противен случай използвайте следното изречение
Текущият проект не изисва допълнителни ресурси и инструменти за разработка.
2.7Използвана методология за разработка
Waterfall / RUP / Agile, - моля цитирайте името на използваният модел и напишете кратко описяние.
2.8Рецензии
Проекта започва със първоначална рецензия за стартиране на проект-а и завърва си финална такава, обобщаваща крайният резултат.
Използват се два типа от рецензии:
-
Рецензии на дизайна
-
Тестови рецензии/демонстрации на продукта
Първоначална/стартова рецензия е формално, документирано и систематизирано събрание по време ан което участниците в проекта се запознават с целите му и останалата информация от плана за управление на проекта..
Рецензии на дизайна са отново формални, документирани и систематизирани събрания по време на които текущият дизайн на проекта (системните, подсистемите) се сравнява спрямо зададените изискванията и очаквания. Тези рецензии се задават предварително в плана на проекта. Целта на тези реценции са да дадат критична оценка на дизайна и разработката, за съвместимост със заложените изисквания; както и да потвърдят и одобрят всички технически аспекти, свързани с горното.
Тестовите рецензии са формални, документрани срещи, на които продукта се демонстрира и тества от заинтересованите страните. Тези рецензии също се задават предварително в плана на проекта след завърване на определени важни етапи от разработката..
Финална рецензия е формална, документиран среща, по време на която ръководителят и собственика на проекта, и други заинтересовани страни валидират полученият продукт (виж процес на валидация в част управление на качеството).
Тази финална рецензия включва и част, посветена на добитият опит от разработката на проекта, използваните процеси и научените уроци.
2.9Управление на софтуерни конфигурации
Опишете процедурите: какви инструменти се използват, къде се съхрянават артефактите от разработката.
2.10Управление на документацията
Опишете как се идентифицират докумените, къде се намират и как се архивират; как се управляват различните версии и какъв е процеса за одобрение/приемане на един документ.
Всеки документ – план или технически подлежи на одобрение:
-
В технически аспект – от член на екипа,
-
За изпълнение на изискванията по качеството
Всеки документ се одобрява от член на екипа. По време
A member of the team approves each document. Докладите от проведените срещи се валидират от всички участвали в тях.
2.11Верификация на продукта
Опишете как се управляват процесите и самите методи за верификация. Включете всички свързани рецензии и документи.... Вижте още секция №5.
3Спецификацияя
Този документ е част от Software Requirements Specifications template. Можете да го погледнете за повече примери.
3.1Режими на работа
FOO системата работи в следните режими:
-
Стартиране: софтуера зарежда компонентие си;
-
Използване: всички части от системата са достъпни за потребителя;
-
Спиране: системата е в процес на спиране.
-
Диагностика: системата е в режим на диагностика
-
И т.н…
Добавете диаграма на различните режими и как се изменят те.
3.1.1Основна функционалност
Това е основата на изискванията. Тази секция съдържа целта на вашият проект описана като технически изисквания.
Какви са функциите на програмата
Използвани алгоритми
…
Изискванията трябва да са кристално ясни и разбираеми. Винаги си задавайте въпроса „Как да тествам това”, когато пишете изискванията.
Пример:
Функционалност
|
SRS-XXX-010 ПРИМЕР
|
Заглавие
|
Примерно изискванe за някаква функция
|
Описание
|
Този софтуерен компоннт трябва да изчисли XYZ въз основа на парметрите a, b и c, използвайки ХХХ алгоритъм.
|
Версия
|
v1.0
|
3.2Безопасност, сигурност и защита на данните
Тази секция е за софтуерни изисквания свързани с конфиденциалността, целостта, надежността и достъпа до данните. Вижте още CyberSecurity изискванията описани от FDA и HIPAA.
3.3Експолатация
Функции свързани със логове, архивиране...
3.4Графични интерфейси
The requirements here may have traceability with result of 62366 standard implementation
3.4.1Изисквания към потребителският интерфейс
Основният изглед на XXX е ….
Вместо да описвате един куп изисквания с текс, използвайте mock-up за да визуализирате, какво желате. Добавете текстово описание единствено за операциите, които се очаква потребителя да изпълни.
3.4.2Помощ
Какво ръководство за потребителя се очаква. Може да бъде online, на печатен носител. Може самата програма да има вградени подсказващи елементи или друг тип документацият – например (windows help)...
Тук се описва и нуждата от диалог „Относно” в който потребителя може да свери текущата версия на програмата...
3.5Външни системи
Ако вашият софтуер е интегриран във друга външна система, моля опишете тази система, както и специфичните изисквания с които вашият сотуер трбва да се съобрази.
3.6Външни интерфейси
Тази секция описва всички хардуерни и софтуерни интерфеси използвани от системата.
3.6.1Хардуерни интерфейси
Описва се всеки един външен хардуер с който системата взаимодейства. Описват се и изисквания как точно системата/софтуера комуникира с тези интерфейси..
3.6.2Мрежови интерфейси
Добавете начинитие на комуникации, използвани от системата. Това са мрежови протоколи, оборудване, Bluetooth …
3.6.3Обмен на данни
Ако софтуерът XXX software е интефейс към друг програма, опишете изискваният за да се осъществи тази комуникация...
Това включва например описание на XML, JSON данните, форматът на пакетите които се пращат м-у софтуерните компоненти, описание на REST API ...
Добавете RDF документи, ако са налични...
3.7Изисквания към средата
In what environment runs the software
3.7.1Хардуерни изисквания
Какъв хардуер е необходим за изпълнението на системата...
3.7.2Софтуерни изисквания
Каква операционна система се поддържа, библиотеки, други програми които се използат.....
3.8Модел на данните
Специфични изисквани към вътрешният модел на данните, като бази данните, бинарни фйлове, XML формати ...
3.9Конфигуриране
Специални изисквания към софтуера, които му позволяват да се адаптират към текущата среда. Тук обикновено бихте описали изисквания – какви конфигурационни опции да са налични...
3.10Верификация на системата
Специални функции позволяващи верификация на софтуера. Например – скрита функция, която активира лог файл, по време на бета-тестовете...
3.11Обучение
Изискванията към уменията и знанията на потребителя и какви обучния трябва да мине преди да използва системата...
Requirement ID
|
SRS-XXX-USR-010 SAMPLE
|
Title
|
E-learning
|
Description
|
XXX is delivered with e-learning module.
|
Version
|
V1.0
|
3.12Пакетиране и инсталация
Изисквания относно как трябва да бъде пакетирана системата, неинте модули и под-модули. Начините на инсталиране (например install shield) ... начините на разпространение – Online, на CD ...
4Архитектура на системата 4.1Архитектура
Not mandatory for class A
4.1.1Общо описание
Дайте общо описание на системата от гледна точка на потребителя::
-
В каква среда работи (вкъщи, до леглото на пациента ...)
-
Кои са потребителите
-
За какво се отнася,
-
Кои са основните функции,
-
Кои са основните интерфейси, входно-изходни данни.
4.1.2Логическа архитектура
Опишете най-важните софтуерни компоненти на системата и техните взаимодействия.
Използвайте UML диаграми за пакетите в системата, различните слоеве (layer), интерфейсите.
Опишете къде точно вървят тези компоненти. При описанието имайте предвид следното::
-
Идентификация на компонента
-
Неговата цел,
-
Как той комуникира с останалите софтуерни интерфейси,
-
Мрежови интерфейси които ползва
-
Хардуерните ресурси от които се нуждае – например:колко памет се нуждае, дисково пространство за инсталиране и за кеш, CPU...
4.1.3Физическа архитектура
Опишете хардуерните компоненти на които върви софтуера. Както и как точно взаимодействат.
Изполвайте компонентни, deployment, network диаграми.
Като описвате компонентите имайте предвид следното:
-
Идентификация на компонент
-
Неговата цел
-
От кои софтуерни компоненти се ползва
-
Технически характеристики като CPU, RAM, disk and so on.
-
Мрежови интерфейси
4.1.4Динамични модели на системата
Вашата система и разработена да отговори на някакви функционални изисвания. За всяка основна функционалност добавете описание от стъпките или размяната на данни които се извършват. Използвайте sequence & collaboration диаграми.
4.2Ограничения и предположения
Не е задължително.
Ако се нуждаете от детайлизиране на някои части от системата направете го тук. Например можете да включите използването на специфичен алгоритъм, използането на memory cache технологии, детайли относно иползвани frameworks, библиотеки, комуникационни протоколи и модели на базите данни…
5Верификация
Тази секция е задължителна.
Внимание, в текущият документ е заложена само една фаза на тестване.
5.1Тестов план 5.1.1Тестова среда
Тази част описва средата в която се изпълняват тестовете. Къде и как точно се изпълняват.
Идентифицирайте точно софтуера, който се използва за тесване::
-
Операционна система и service packs
-
Необходими драйвери (ако се нуждаете от такива)
-
Инструменти за Backup / recovery
-
Web, blogs, CMS, Databases engines,
-
Начини и инструменти за анализ на Memory, disk usage, CPU, и трансвер на мрежови данни.
-
Test coverage или системи за управление на тестовете
-
Симулатори, генератории на данни за хардуера или софтуера, който нямате в наличност
-
Всякакъв друг помощен софтуер, който сте разработили за да направите тестовете.
За прости проетки много от тези инструменти могат да се предоставят от операционната система (df, du, ps, top, dmesg, taskmanager, control panel …)
Опишете точно данните, които се използват по времето на тестовете. Тяхната идентификация, структура, съдържание, местоположение, съхранение:,
-
Входни файлове,
-
Файлове с данни,
-
Скриптове за генериране на даните,
-
Изходни файлове, логове
Опишете какви документи се очакват като артефакти от тестването.
5.1.2Тестване в реални условия
Ако имате възможност да тествате софтуера в реални условия, имайте предвид че трябва да предоставите необходимият хардуер, софтуер, данни и документация на клиента. Опишете какъв е начинът клиента да съобщи за намерените проблеми и какви логове са нужни да предостави..
5.2Описание на тестовете 5.2.1Изисквания към тестовете
Всеки тест е уникален и съдържа:
-
Уникален идентификатор,
-
Описание на целта на теста,
-
Връзка към съответното изискване от секция §3 на този документ,
-
Методите използвани за верификация (I, A, D, T),
-
Процедури за записване на данните и последващата им обработка и анализ,
-
Предположения или ограничение, ако има такива,
-
Забележки относно безопасността и сигурността.
Идентификатора има следната структура::
-
Дефинирайте формата на вашият уникален идентификатор.
-
Например добавете –Т-<НОМЕР> след ID-то на изискването, което тествате. Номерът се ползва ако това изискване се тества от повече от един тест.
5.2.2Описание на тестовете
Връзката м-у тестовете и изискванията към системата, описани в секция §3 са отбелязани също в сеция §7.
Определено изискване към системата може да се нуждае от повече от един тест за да се валидира. В този случай всички тестове трябва да минат успешно за да бъде валидирано това конкретно изискване..
Опишете всеки един тест използвайки примера по-долу. Не всички полета са нужни. Отбележете с N/A ненужните полета.
Тест №
|
T-REQ-001
|
|
Описание на теста
|
Small description
|
|
Изискване №
|
SRS-REQ-001
|
Verification method: I,A,D,T
|
Първоначални условия
|
The state of software before test
|
You may reference a procedure or it may be the result of previous test
|
Входни данни
|
Input data from any test tool, input files name and location
|
You may reference a procedure to use the test tool
|
Метод на събиране на данните
|
Recording and post processing of output data
|
You may reference a procedure to record data with a test tool
|
Данни от теста
|
Output data files names and location, logs …
|
Give unique name out output data files.
|
Предположения и ограничения
|
If any, may be limited access to a tool, license …
|
|
Очаквани резултати
|
List here the results of test
|
And the criteria to evaluate the result
|
Тестова процедура
|
|
|
Стъпка №
|
Operator actions
|
Expected result and evaluation criteria
|
1
|
Start foo
|
Foo is started
|
6Резултати от тестоветес 6.1Обосновка на резултатите
След изплнението на тест, решението дали той е успешен се взима въз основа на следните правила::
-
Минал: Теста получава този статут, ако всички негови стъпки са изпълнени успешно и реалният резултат е съвместим/съизмерим с очакваните резултати..
-
Провален: Тестът е провален ако някоя стъпка е провалена, или когато резултатът от изпълнение на стъпка се различава от очакваните резултати.
-
Неизпълнен: Първоначалният статут на теста, преди да се стартира неговото изпълнение..
-
Недовършен: Статутът на теста, когато някоя негова стъпка е все още със статус „Неизпълнен”.
6.2Резултати
Дайте малко информация относно тестовете.
Програмата XXX (версия x.y.z) е тествана на xxx тестова плаформа, разположена в xxx, fот yyyy/mm/dd доe yyyy/mm/dd. Тестовете са изпълнени от: Иван Петров, Петър Иванов
Копирайте таблицата от теста, като добавите колона „Резултат”. Попълнете тази колона след изпълнение на теста. Ако теста е провален, добавете и номера на репорта за грешка.
Test ID
|
T-REQ-001
|
OVERALL RESULT
|
OK
|
Test description
|
Small description
|
|
|
Verified Requirement
|
SRS-REQ-001
|
Verification method: I,A,D,T
|
|
Initial conditions
|
The state of software before test
|
You may reference a procedure or it may be the result of previous test
|
|
Tests inputs
|
Input data from any test tool, input files name and location
|
You may reference a procedure to use the test tool
|
|
Data collection actions
|
Recording and post processing of output data
|
You may reference a procedure to record data with a test tool
|
|
Tests outputs
|
Output data files names and location, logs …
|
Give unique name out output data files.
|
|
Assumptions and constraints
|
If any, may be limited access to a tool, license …
|
|
|
Expected results and criteria
|
List here the results of test
|
And the criteria to evaluate the result
|
|
Test procedure
|
|
|
|
Step number
|
Operator actions
|
Expected result and evaluation criteria
|
Result
|
1
|
Start foo
|
Foo is started
|
OK
|
7Проследимост на изискванията
Тази таблица дава ясна връзка между изискванията и тестовете; както и методологията за изпълнение.
Методите за верификация на изискванията са дадени по-долу:
-
Инспекци (И): контрол или визуална верификация
-
Анализ(A): верификация базирана на някакви аналитични свидетелства/документи
-
Демонстрация (Д): верификация на специални функционални изисквания, които нямат ясни количествени изражение
-
Тест(T): верификация на количествени характеристики, посредством измервания
За всяко изискване описано в този документ е дефиниран метод за верификаци. Методите са съкратени до следните означения: И, А, Д и Т.
За всяко изискване трябва да има ПОНЕ ЕДИН тест.
Изискване №
|
Описание на изискването
|
Тест №
|
Описание на теста
|
Метод
|
|
|
|
|
|
This Template is the property of Cyrille Michaud
License terms: see http://blog.cm-dm.com/post/2011/11/04/License
Сподели с приятели: |