Šablona SRS: specifikace softwarových požadavků
Šablona specifikace softwarových požadavků (SRS) popisuje funkce, omezení a jejich ověření. Zkopírujte si praktickou strukturu a vyplněný příklad.
Shrnutí a kontext
Specifikace softwarových požadavků (SRS, Software Requirements Specification) popisuje, co má systém dělat, jaká omezení musí splnit a jak ověříte, že je požadavek splněn. Níže najdete šablonu ke zkopírování a vyplněný příklad pro malou aplikaci.
1. Co je specifikace softwarových požadavků
SRS je strukturovaný seznam požadavků na funkce, výkon, omezení návrhu a vnější rozhraní softwaru. Každý požadavek má být samostatně srozumitelný a musí být možné ověřit, zda ho systém splňuje. Procesy a dokumenty pro práci s požadavky popisuje norma ISO/IEC/IEEE 29148.
SRS navazuje na dokumentPRD (Product Requirements Document), který vysvětluje problém, uživatele a cíle produktu. Dokument pro technický návrh pak popisuje, jak tým požadavky splní. Pokud potřebujete rozlišit tyto dokumenty, přečtěte si šablonu PRD a dokument návrhu softwaru.
2. Kdy má SRS smysl
SRS pomáhá, když se na jednom systému domlouvá více rolí, když aplikaci předáváte klientovi nebo když smlouva či regulace vyžaduje doložit, jaké vlastnosti má systém mít. Požadavky se hodí také u integrací, migrací dat a kvalitativních cílů, které nejdou odvodit jen ze seznamu funkcí.
Pro malou změnu může stačit dobře popsaný úkol nebo několik akceptačních kritérií. Nevytvářejte dlouhý dokument jen proto, že existuje formální vzor. Rozsah SRS přizpůsobte riziku změny a tomu, co si musí vývoj, testování, provoz nebo zákazník předat.
3. Co do SRS zahrnout
Specifikace má dát každému požadavku kontext, jedinečné označení a způsob ověření. NASA ve svém handbooku pro softwarové požadavky doporučuje, aby byly požadavky mimo jiné jasné, ověřitelné, sledovatelné a proveditelné.
| Část | Co zaznamenat |
|---|---|
| Účel a rozsah | Proč dokument vzniká, co pokrývá a co je mimo rozsah. |
| Kontext | Uživatelé, role, okolní systémy, pojmy a předpoklady. |
| Funkční požadavky | Jednotlivá pozorovatelná chování, každé s vlastním ID. |
| Kvalitativní požadavky | Měřitelné cíle pro výkon, bezpečnost, dostupnost nebo přístupnost. |
| Rozhraní a data | Napojení na jiné systémy, formáty, vstupy a chybové stavy. |
| Ověření a změny | Jak požadavek otestujete, kdo jej schvaluje a jak zaznamenáte změnu. |
4. Šablona specifikace softwarových požadavků ke zkopírování
Zkopírujte šablonu do repozitáře nebo do systému pro dokumentaci, který používáte pro specifikace. Nepotřebné části smažte; neznámé hodnoty označte jako otevřené otázky místo toho, abyste je domýšleli.
# <Název systému nebo změny>: specifikace softwarových požadavků
Vlastník: <osoba nebo tým>
Stav: návrh | ke kontrole | schváleno | nahrazeno
Verze a datum: <verze> · <YYYY-MM-DD>
Související dokumenty: <PRD> · <návrh> · <testovací plán>
## 1. Účel a rozsah
- Účel systému nebo změny:
- Co tato specifikace pokrývá:
- Co je mimo rozsah:
## 2. Kontext a uživatelé
- Uživatelé a jejich role:
- Okolní systémy a rozhraní:
- Pojmy a zkratky:
## 3. Předpoklady a omezení
- Předpoklady, které je třeba potvrdit:
- Technická, smluvní nebo provozní omezení:
## 4. Funkční požadavky
| ID | Požadavek | Priorita | Ověření |
| --- | --- | --- | --- |
| FR-01 | Systém musí ... | musí / měl by / může | test nebo kontrola ... |
## 5. Kvalitativní požadavky
| ID | Oblast | Měřitelný požadavek | Ověření |
| --- | --- | --- | --- |
| NFR-01 | Výkon | ... | ... |
## 6. Data a externí rozhraní
- Vstupy, výstupy a formáty:
- Externí služby a jejich chování při chybě:
- Osobní nebo citlivá data a pravidla přístupu:
## 7. Ověření a předání
| Požadavek | Test nebo důkaz | Vlastník | Výsledek |
| --- | --- | --- | --- |
| FR-01 | ... | ... | ... |
## 8. Otevřené otázky a historie změn
- Otázka / rozhodnutí / vlastník / termín:
- Verze / datum / změna / schválil:5. Příklad SRS pro rezervaci firemního vybavení
Představte si interní aplikaci, ve které si zaměstnanci rezervují sdílené vybavení. Ukázka je záměrně krátká; konkrétní limity a postup schvalování musí tým dohodnout pro svůj systém.
Čas odezvy i velikost dat musí odpovídat dohodnutému použití. Číslo bez prostředí, objemu a způsobu měření není ověřitelný požadavek.
| ID | Požadavek | Jak ho ověřit |
|---|---|---|
| FR-01 | Uživatel může zobrazit dostupné vybavení pro zvolené období. | Porovnat výsledek s rezervacemi uloženými pro stejné období. |
| FR-02 | Systém odmítne rezervaci, která se časově překrývá s potvrzenou rezervací stejného vybavení. | Odeslat překrývající se požadavek a ověřit, že se neuloží. |
| FR-03 | Správce může žádost schválit nebo zamítnout a žadatel vidí její stav. | Ověřit oba výsledky žádosti na účtu žadatele. |
| NFR-01 | Dostupnost vybavení se zobrazí do 2 sekund při 500 položkách. | Změřit odezvu při 500 položkách. |
6. Jak psát požadavky, které lze ověřit
Každý řádek má popisovat jednu věc, kterou může tester nebo zákazník potvrdit. Vyhněte se slovům jako rychlý, snadný nebo bezpečný, pokud za nimi není konkrétní podmínka a měření.
Například „aplikace má rychle zobrazit vybavení“ přepište na „seznam se zobrazí do dvou sekund při 500 položkách“. Určete, zda jde o požadavek, doporučení nebo volitelnou možnost a používejte stejné označení v celém dokumentu. Přesnou formulaci přizpůsobte smlouvě i způsobu, jakým tým požadavky schvaluje.
7. Jak SRS udržet i po schválení
Uložte schválenou verzi tam, kde ji mohou najít vývojáři, testeři i zadavatel. Změny rozsahu označte datem změny a autorem; při změně požadavku upravte také navázané testy a technický návrh. Pro navazující přehled si můžete projít šablonu dokumentace softwaru.
AboutTheApp může u aplikace zobrazit odkaz na SRS v kategorii Dokumentace. Samotný dokument v něm nevytváří ani needituje, proto jej dál udržujte v repozitáři nebo dokumentovém systému, který používáte jako zdroj pravdy.
Časté otázky
Co obsahuje specifikace softwarových požadavků?
Obsahuje účel a rozsah systému, funkční a kvalitativní požadavky, rozhraní, předpoklady a způsob ověření. Přesné části se liší podle smlouvy, rizika a velikosti projektu.
Jaký je rozdíl mezi SRS a PRD?
PRD popisuje problém, uživatele a cíle produktu. SRS převádí dohodnutý rozsah na konkrétní požadavky, omezení a ověřovací kritéria.
Jaký je rozdíl mezi SRS a dokumentem návrhu softwaru?
SRS popisuje, co má systém splnit a jak to ověříte. Dokument návrhu popisuje technické řešení, které požadavky naplní.
Musí každý software mít samostatný dokument SRS?
Ne. U malé změny mohou stačit požadavky a akceptační kritéria v úkolu. Samostatné SRS se hodí, když potřebujete sdílený, schvalovaný nebo smluvně doložitelný rozsah.
Kde se má specifikace softwarových požadavků uchovávat?
Uchovávejte ji v systému s řízením verzí a přístupem pro lidi, kteří ji schvalují a ověřují. Může to být repozitář nebo dokumentový systém; důležité je udržovat stabilní odkaz a historii změn.
Ve zkratce
Dobrá specifikace požadavků popisuje očekávané chování a omezení tak, aby je šlo nezávisle ověřit. Začněte krátkou šablonou a rozšiřujte ji jen o části, které projekt potřebuje.
Chcete mít odkaz na specifikaci u aplikace?
V AboutTheApp můžete propojit aplikaci s její specifikací, repozitářem a další dokumentací.