Software om functionele eisen vast te leggen voor een webapp

[Wijnbo]

Sinds oktober vorig jaar ben ik werkzaam bij een bedrijf in de industriële automatisering. Bij klanten wordt een webapplicatie weggezet, waaraan ik werk. Echter, deze webapplicatie is grotendeels abracadabra voor mij. Het betreffen vaak vakspecifieke termen, en een functionele omschrijving ontbreekt in het geheel.

Nu is mijn vraag:

Bestaat er software die functionele eisen kan vast leggen van een webapplicatie tot in detail?

Denk hierbij aan het volgende:

Voorbeeld : Pagina x, dropdownlist y
-omschrijving waarmee deze lijst gevuld is
- wat zijn toegestane waarden
- indien de waarde x is, dan is textbox z uitgeschakeld. Dit omdat q,p en t samen 15 zijn, en daarom kan het op pagina a verkeerd gaan als gebruiker checkbox e aanvinkt ( )

Verder moet de software goed te beheren zijn. Een word documentje volstaat natuurlijk niet, zelf zat ik aan een WIKI o.i.d. te denken, maar zijn er alternatieven? Ik plaats dit topic in programming omdat ik vermoed dat hier de mensen zitten die iets soortgelijks vast wel eens hebben meegemaakt.

[TheDane]

Waarom volstaat een word documentje "natuurlijk niet" ?

Ik gebruik naast Word vaak Visio om use cases in beeld te brengen, soms wat Excel voor lijstjes, maar that about covers it.

Wat is, denk je, de toegevoegde waarde van een wiki?

[Wijnbo]

TheDane schreef op donderdag 18 februari 2010 @ 12:06:
Waarom volstaat een word documentje "natuurlijk niet" ?

Ik gebruik naast Word vaak Visio om use cases in beeld te brengen, soms wat Excel voor lijstjes, maar that about covers it.

Wat is, denk je, de toegevoegde waarde van een wiki?

Het betreft hier een applicatie met ontzettend veel vaktermen, ontzettend veel voorwaarden (dit lijstje wordt gevuld met waarden uit die tabel, maar alleen als een record inner joint met nog 4 andere tabellen, etc)

Dit is dus nergens omschreven.

Stel je het volgende voor:

Je mag een lievelingskleur kiezen op een formulier. Aan jou de opdracht dat formulier te maken. Good luck.

- Hoeveel keuzes heb je? Onbekend
- Welke keuzes heb je? Onbekend
- Zijn er uitzonderingen (Indien vrouw, dan mag je geen rood kiezen, tenzij je emailadres met de letter d begint) Onbekend.

Dit is nergens vastgelegd. Een word document wordt eenmalig gemaakt, op een server gepleurd en niet meer onderhouden. Een wiki is een stuk onderhoudbaarder, maar misschien zijn er andere (betere) oplossing.

Dit betreft natuurlijk geen 10 weken projectje, maar is een softwarepakket wat door meerdere klanten wordt gebruikt en al jaren wordt ontwikkeld.

[beany]

Wat TheDane zegt!

Functionele ontwerpen en use cases zijn hiervoor bedoelt. Dan zou, beetje kort door de bocht, iemand zonder inhoudelijke kennis het gebeuren moeten kunnen implementeren.

[Wijnbo]

beany schreef op donderdag 18 februari 2010 @ 12:12:
Wat TheDane zegt!

Functionele ontwerpen en use cases zijn hiervoor bedoelt. Dan zou, beetje kort door de bocht, iemand zonder inhoudelijke kennis het gebeuren moeten kunnen implementeren.

Leuk, maar ik zoek dus goede software hiervoor. Het liefst waarin ik een screenshot kan gooien, en beschrijving kan geven aan de verschillende items.

[Xiphalon]

DocTool van PNA kan dit volgens mij best goed.

[flashin]

Mja je hebt wel wat documentatie software, maar ik zou het structureler aanpakken en gewoon er voor gaan zitten met de personen die de specifieke kennis wel hebben om tot een goed document te komen.

Software moet goed te beheren zijn, het klinkt een beetje te laat om er nog aan te beginnen maar denk dan aan versiebeheer, commentaar, coding style etc.

[beany]

Wijnbo schreef op donderdag 18 februari 2010 @ 12:19:
[...]


Leuk, maar ik zoek dus goede software hiervoor. Het liefst waarin ik een screenshot kan gooien, en beschrijving kan geven aan de verschillende items.

Word, Visio

In Word kan je prima screenshots hangen. Je kan met Visio ook user interfaces maken(waar ongeveer welke invoer velden moeten komen e.d.)

[YopY]

Wijnbo schreef op donderdag 18 februari 2010 @ 12:19:
[...]


Leuk, maar ik zoek dus goede software hiervoor. Het liefst waarin ik een screenshot kan gooien, en beschrijving kan geven aan de verschillende items.

Word, alt + printscreen en paste, gelijk resizen. Termen / woordenlijsten ('glossary') is ook een standaardfunctie van Word en gelijksoortige texteditors. Voor onderhoudbaarheid door meerdere personen zou een wiki of iets dergelijks wel handig zijn, maar dan moet je wel strikte regels daarbij houden en veel onderhoud doen.

[flashin]

Werken met meerdere personen aan documenten zou ik dan ook doen via google docs.

[Verwijderd]

Hoe kan je überhaupt aan een implementatie beginnen als je de randvoorwaarden niet helder hebt? Deze functionele eisen moeten niet bij jou vandaan komen maar uit het bedrijf/opdrachtgever. Jij bent uiteraard wel degene die deze functionele eisen boven water moet krijgen en vertaalt naar een implementatie.

Begrijp ik uit je verhaal dat je nu 4 maanden aan het 'zwemmen' bent met een opdracht die je niet begrijpt door de vele vaktermen?

Wellicht (als je dat nog niet hebt gedaan) je verdiepen in UML en mbv UML applicaties de eisen, processen etc vastleggen.

[ Voor 13% gewijzigd door Verwijderd op 18-02-2010 13:12 ]

[Wijnbo]

flashin schreef op donderdag 18 februari 2010 @ 12:27:
Mja je hebt wel wat documentatie software, maar ik zou het structureler aanpakken en gewoon er voor gaan zitten met de personen die de specifieke kennis wel hebben om tot een goed document te komen.

Software moet goed te beheren zijn, het klinkt een beetje te laat om er nog aan te beginnen maar denk dan aan versiebeheer, commentaar, coding style etc.

Snap ik, maar de personen die samen alle kennis hebben hebben ook hun eigen werkzaamheden. Versiebeheer en code documentatie zijn we hard mee aan het werk, coding style is nog ongeveer 0.

[bindsa]

Van wat ik er van begrijp is wat je wil eigenlijk de software reverse engineeren, om een goede documentatie te maken. Mocht het een app zijn met MySQL dan is bijv. MySQL Workbench heel makkelijk.

Verder staan hier een paar nuttige links:

http://www.softwaredocume...deDocumentationTools.aspx

Google verder even:

http://lmgtfy.com/?q=software+documentation+tool

Laat ook de ontwerpers hun code even van commentaar voorzien, dat is mijns inziens een must bij software projecten.

[Wijnbo]

Verwijderd schreef op donderdag 18 februari 2010 @ 13:10:
Hoe kan je überhaupt aan een implementatie beginnen als je de randvoorwaarden niet helder hebt? Deze functionele eisen moeten niet bij jou vandaan komen maar uit het bedrijf/opdrachtgever. Jij bent uiteraard wel degene die deze functionele eisen boven water moet krijgen en vertaalt naar een implementatie.

Begrijp ik uit je verhaal dat je nu 4 maanden aan het 'zwemmen' bent met een opdracht die je niet begrijpt door de vele vaktermen?

Wellicht (als je dat nog niet hebt gedaan) je verdiepen in UML en mbv UML applicaties de eisen, processen etc vastleggen.

Ergens begrijp je het wel, ergens ook niet. Begin alsjeblieft niet over UML, dat werkt hier gewoon niet. Zal ooit misschien veranderen.

Er komt een nieuwe versie van een bestaande web applicatie, met als doel de onderhoudbaarheid te vergroten. (Als ik zeg dat in de originele versie geen masterpages of generieke manier om database handelingen te doen is (datatables, utility classes, losse datareaders, inline sql, etc), weet je dan genoeg?)

De achterliggende database blijft het zelfde.

Heb al erg mijn best gedaan om sourcesafe een schop te geven en over te gaan op SVN. XML documentatie? Was tot op heden nog niet aanwezig. Maar dan heb ik het slechts over code.

Begrijp me niet verkeerd, het is een ontzettend leuke baan bij een leuk bedrijf, maar er mist gewoon ontzettend veel documentatie, en dan vooral de functionele kant.

[Janoz]

Wijnbo schreef op donderdag 18 februari 2010 @ 13:18:
Ergens begrijp je het wel, ergens ook niet. Begin alsjeblieft niet over UML, dat werkt hier gewoon niet. Zal ooit misschien veranderen.

Met alle respect, maar ik denk dat jij degene bent die het even niet begrijpt. Je probleem is helemaal niet het vinden van de tool. Word is volgens jou niet strict genoeg, terwijl UML juist weer te strict is?

Het op 1 na grootste probleem dat jullie daar hebben is dat de hele applicatie en de ontwikkelstraat er omheen 1 grote puinzooi is. Het grootste probleem is dat de mensen die het budget bepalen dat niet inzien.

Het probleem daar oplossen doe je niet met de introductie van een tooltje. Zoals je zelf al aangeeft is de mentaliteit daarbij al snel 'leuk dat tooltje, maar fix dit even snel en we passen de documentatie later wel aan', wat dus uiteindelijk nooit gebeurt. Dat kan met word, dat kan met een wiki en dat kan met IBM's rup tooling. Om het probleem op te lossen zal er een mentaliteits verandering plaats moeten vinden. In de eerste plaats zal het managment overtuigd moeten raken dat dit een keer uit de bocht gaat vliegen en dat ze eens iets verder dan de omzetcijfers van deze maand moeten kijken. Nog belangrijker is dat de ontwikkelaars zich eens over hun eigen arrogantie heen gaan zetten en zich eens gaan conformeren naar een duidelijk afgesproken workflow.

[cariolive23]

Waarom zou UML niet werken? Dat is een verzameling diagrammen met daarbij ook vast wel een diagram waar jij, om mee te beginnen, uitstekend mee uit de voeten kan. Beetje vreemd om dit zo in één keer af te serveren zonder dat je zelf enig alternatief hebt.

Ik zou beginnen met Use Case-diagrammen, die zijn eenvoudig en geven je snel inzicht in de werkwijzen.

[bat266]

Ik was bezig een heel verhaal te typen, maar wat janoz zegt dus. (note to self eerst refreshen voor starten te antwoorden)

[YopY]

bat266 schreef op donderdag 18 februari 2010 @ 15:12:
Ik was bezig een heel verhaal te typen, maar wat janoz zegt dus. (note to self eerst refreshen voor starten te antwoorden)

Je hoeft niet te posten dat je zou posten hoor. Overigens, d'r zat dik anderhalf uur tussen Janoz z'n reactie en die van jou - d'r zijn maar weinig mensen die anderhalf uur doen over een reactie, danwel het scherm zo lang openhouden.

[roy-t]

Voor het database gedeelte zou je eens kunnen kijken naar ORM, dat is een stuk expressiever dan UML en ERD maar alleen geschikt voor database (waar je allemaal rare dingen moet doen om keys e.d. aan te geven).

Verder denk ik niet dat er iets is tussen UML en Word in, aangezien UML al vrij niet strict is. (UML is bedacht van uit een syntactische achtergrond waar ORM vanuit een wiskundige kant (predikaat logica) ontwikkeld is, beide zijn uiteindelijk simpel te begrijpen diagrammen, maar ORM garandeert samen met zijn tools een veel correctere database.

[cariolive23]

roy-t schreef op vrijdag 19 februari 2010 @ 14:51:
Voor het database gedeelte zou je eens kunnen kijken naar ORM, dat is een stuk expressiever dan UML en ERD maar alleen geschikt voor database (waar je allemaal rare dingen moet doen om keys e.d. aan te geven).

Wat heeft ORM met UML te maken en waarom zouden hierin conflicten ontstaan? UML sluit ORM helemaal niet uit, maar of ORM nu zo handig is...

Ben toevallig nu bezig met een ORM-probleem, Hibernate die 1500 queries aanmaakt om een paar KB-data op te vragen uit de database. Men dacht dat de database langzaam was, inmiddels is duidelijk dat de code gewoon zwaar ruk is en de database gemiddeld 1 ms per query nodig heeft. Die ene duizendste van een seconde valt niet/nauwelijks te optimaliseren, zelfs een keer zo snel maken zou niet snel genoeg zijn. Men moet eerst maar eens zorgen dat minstens 80% van de queries wordt afgeschoten, ze zijn volkomen overbodig.

ORM, breek me de bek niet los...

[Creepy]

ORM is naast Object Relation Mapping ook een modeling techniek: "Object Role Modeling" (orm.net). Ik denk dat roy-t dat bedoelt i.p.v. een ORM systeem ala Hibernate.

[cariolive23]

Ah, het zal mijn frustratie zijn die mij op het verkeerde been zette.

[roy-t]

Creepy schreef op vrijdag 19 februari 2010 @ 15:13:
ORM is naast Object Relation Mapping ook een modeling techniek: "Object Role Modeling" (orm.net). Ik denk dat roy-t dat bedoelt i.p.v. een ORM systeem ala Hibernate.

Ik bedoelde inderdaad ORM als Object Role Modelling als:

[Verwijderd]

Probeer StarUML eens. Ik gebruik hem voor use-cases, klassendiagrammen, sequentie- en activitydiagrammen, ...
Vergeet wel de module om ERD's te maken niet te downloaden. Deze moet je gewoon uitpakken en in je module-map plaatsen.

[Sybr_E-N]

De UML tool waar ik als developer veel mee te maken heb is Enterprise Architect van Sparx Systems.

Alle documentatie kun je in deze tool kwijt en is ook gericht op software ontwikkel processen zoals RUP enzo.

[b12e]

Ik steun Rubinski_be, starUML is een goed, gratis alternatief voor tools zoals Visio. Vooral voor diagrammen dan. Echt geweldig gewoon, volledig gratis, en zeer uitgebreid voor allerhande diagrammen (en zeker niet beperkt tot use-cases, klassendiagrammen,sequentiediagrammen en activitydiagrammen)