Dokumentum termékek készítésének általános szempontjai
Kerüljük a duplikációt
Az egyes dokumentumokat úgy kell elkészíteni, hogy azok között a tartalmi átfedés minimális legyen. Ennek érdekében az egyes dokumentumsablonokban a tartalmi elemeknek nemcsak a célja, de a kifejtés elvárt szintje is definiálásra kerül. Az egyes dokumentumok között logikai kapcsolat megteremtése, valamint az érthetőség érdekében előfordulhat, hogy az egyik dokumentum megismétel egy másik (előfeltétel) dokumentumban található információt, de ennek célja, minden esetben az adott dokumentumtípusban történő továbbfelhasználás kell legyen.
Legyenek a dokumentumoknak önmagukban konzisztensek
A dokumentumoknak önmaguknak az adott tartalmi cél érdekében önállóan érthetőknek kell lenniük. Ennek érdekében a megértéshez szükséges szövegszerű átemeléseket tartalmazhatnak előzmény dokumentumból, valamint tartalmazhatnak kifele mutató hivatkozásokat később elkészítendő vagy mellérendelt dokumentumokra.
Dokumentumhivatkozások kezelése
A dokumentumok egymáshoz képesti viszonyában három eset különböztethető meg:
előfeltétel dokumentum, amely a tárgydokumentum előtt kell elkészüljön és a dokumentumsablonokban a kapcsolódó dokumentumokként kell megjeleníteni.
mellérendelt dokumentum, amely a tárgydokumentummal a fejlesztési folyamatban párhuzamosan készül;
rákövetkező dokumentum, amely a tárgydokumentum elkészítését követően, annak eredményeit felhasználva készül el.
Egy sablon kidolgozásakor csak olyan információk tekinthetőek ismertnek, melyek egy előzmény dokumentumban már meghatározásra kerültek. Ezekre való tényleges utalásnál nem kell a forrás konkrét helyét a tárgydokumentumban megadni.
Amennyiben a tárgydokumentumban valamely mellérendelt dokumentumra történik hivatkozás, akkor a hivatkozásnál minimálisan (és ahol értelmezhető) a 2. szintű címig meg kell adni a hivatkozás forrását.
A tárgydokumentum a részletek kifejtését gyakran egy később elkészülő dokumentum hatókörébe utalhatja, amennyiben az túlmutat a tárgydokumentum célján. Ilyen esetekben a dokumentáció azonosítása erejéig kötelező megadni, hogy mely rákövetkező dokumentumban tervezi a Szállító az adott részletek kifejtését.
Fejlesztési szakaszok
A fejlesztési sablonok úgy lettek meghatározva, hogy azok a lehető legkevesebb feltételezéssel éljenek az elkészülő rendszer felépítésére. Mindezek mellett a sablonok a fejlesztési folyamatot általánosan az alábbi szakaszokra bontja:
| Szakasz | Magyarázat |
|---|---|
| Tervezés | Ebben a szakaszban kerül az alkalmazás által teljesítendő elvárások és azokat megvalósító funkciók tervezésre. A tervezési szakasz akkor zárul, amikor minden lényeges funkcionális, architekturális döntés megszületett. |
| Fejlesztés | Ebben a szakaszban valósul meg a tényleges rendszerfejlesztés. |
| Megvalósítás | Ebben a szakaszban történik meg a rendszer teszt és éles környezetbe való telepítése. |
| Tesztelés | Ebben a szakaszban a rendszer integrációs, és végfelhasználói, valamint egyéb olyan tesztelési feladatai történnek meg, amelyek már a Megrendelővel való együttműködést is igénylik. |
| Üzemeltetés és használat | A rendszer élesítését követően éles működés szakasza. |
| Irányítás | Egy általános szakasz, ami a teljes fejlesztési folyamaton átívelő menedzsment és minőségbiztosítási tevékenységeket fogja össze. |
Az egyes szakaszoknak nem kell szigorúan elválniuk időben, ahogy az is megengedett egy projekt esetében, hogy a szakaszok több ciklusban ismétlődjenek akár részben, vagy teljes egészében.
A dokumentumsablonok áttekintése és a tartalmi elvárások a FLORA Környezet belső tudásmegosztó terén érhető el.