Gebaseerd op het KD Applicatie- en mediaontwikkeling

Inleiding

In dit document vind je informatie over de fases en voor het maken van documentatie bij het uitvoeren van projecten als Applicatieontwikkelaar.

Algemeen

De volgende opmerkingen gelden voor elk document dat je schrijft binnen de uitvoering van een project. Controleer dus elke document voor dat je inlevert of laat controleren op deze punten:

Begin elk document met een duidelijke inleiding. In de inleiding vertel je waar het document over gaat zodat de lezer weet wat hij gaat lezen. Probeer daarbij zo specifiek mogelijk te zijn; geef geen uitleg wat een Schriftelijk Advies, FO of TO is maar leg kort uit wat je gaat vertellen, hoe het document is op gebouwd of iets dat de lezer moet weten voordat hij het document gaat lezen.

Zorg dat de opmaak van de documenten consequent is. Gebruik niet onnodig veel verschillende soorten opmaak van de tekst zonder dat je daar een reden voor hebt, dit leidt alleen maar af van de inhoud. Vermijdt onnodig gebruik van ingewikkelde formuleringen als het document is bedoeld voor de opdrachtgever. Gebruik zoveel mogelijk de functies van je teksteditor om het document netjes op te maken, bijvoorbeeld kop- en voetteksten, automatische inhoudsopgave, opmaakprofielen etc. De verschillende documenten binnen een project moeten een gelijke opmaak hebben zodat je duidelijk kunt zien dat ze bij elkaar horen.

Zorg dat belangrijke informatie duidelijk in of op het document vermeld staat. Als je een document op de grond vindt moet je kunnen zien van wie het is, waarvoor en wanneer het is geschreven en welke pagina.

Geef alle documenten een duidelijk versienummer zodat je weet wat je laatste versie is, en wat een eerdere versie is.. Elke keer als je een document (voorlopig) oplevert geef het een nieuw nummer. Aan het nummer moet ook te zien zijn dat het een definitieve versie is. Begin je nummering bijvoorbeeld met 0.1, 0.2, 0.3 … De definitieve versie krijgt dan het nummer 1.0. Als het definitieve document in de loop van het project toch nog moet aanpassen, door bijvoorbeeld nieuwe informatie of inzichten, ga je verder met 1.1, 1.2 etc. Zo is duidelijk te zien dat de laatste documenten een aanpassing is op de definitieve versie.

Beoordeling documentatie

Naast dat de documentatie een zakelijke lay-out en taalgebruik bevat en dat het inhoudelijk correct is wordt bij de beoordeling van de documentatie wordt er op de volgende punten gelet:

Onderdeel:	Uitleg:
Titelblad:	een duidelijk voorblad met daarop vermeld: de naam van het project de naam van het product, denk aan Plan van aanpak, Functioneel ontwerp…etc plaats, de maand en het jaartal van publicatie (inlever datum) en een versienummer de naam of namen van degenen die aan het product hebben meegewerkt.
Inhoudsopgave:	de inhoudsopgave vermeldt de titels van de hoofdstukken, paragrafen met de daarmee corresponderende nummering en de pagina’s. Deze moet automatisch gegenereerd worden. Zo krijgt de lezer een beeld van de grote lijn van de structuur. De inhoudsopgave moet een duidelijk overzicht geven van het document. Tip: is de opbouw van de hoofdstukken logisch?
Voorwoord:	Een voorwoord zegt niets over de inhoud van de tekst, maar verhaalt over de totstandkoming ervan, vaak in een persoonlijke vorm. Hierin behandel je zaken die niet rechtstreeks in verband staan met het onderwerp zoals: bedankjes aan medewerkers en instellingen de aanleiding tot het document als er een vorige document bestaat: het verband met het vorige
Inleiding:	een definitie en afbakening van het onderwerp: de probleemstelling (tip: gebruik hierbij de project naam) een uitleg over de opbouw van het document toelichting op de methode van onderzoek Opmerking: het voorwoord en de inleiding mogen op 1 pagina worden gezet.
Kern:	Onder de volgende links is de kernonderverdeling van onderstaande documenten nauwkeurig uitgewerkt. Behoefteanalyse Plan van aanpak Functioneel ontwerp Technisch ontwerp Beschrijving van de ontwikkelomgeving Over het algemeen geldt dat de overzichtelijkheid moet blijken uit de indeling in hoofdstukken en paragrafen (Zie ook de inhoudsopgave)
Slot:	Dit is het laatste hoofdstuk waarin: een terugblik op de kern wordt gegeven (samenvatting) conclusies uit de voorafgaande hoofdstukken worden getrokken
Bronvermelding:	geef precies aan waar je de informatie gevonden hebt (boeken, tijdschriften, kranten, Internet). Bij internet vermeldt je de site naam. Opmerking: het slot en de bronvermelding mogen op 1 pagina worden gezet.
De verzorging:	Zorg dat je alle koppen en subkoppen een opmaakprofiel geeft. Dit heb je nodig om later uw inhoudsopgave te genereren. De hoofdstukken en paragrafen dienen exact dezelfde benaming te hebben als in de inhoudsopgave. (Gebruik hiervoor bijv. de optie Inhoudsopgave in Word) Gebruik een voettekst met daarin, (links)namen, (midden)documentnaam, (rechts)blz. nummering in het format Pagina X van X. nummer de pagina’s behalve titelblad. De (hoofd)letters die jij voor de hoofdstuktitels enz. gebruikt moeten consequent van dezelfde soort zijn. Het standaard lettergrootte dat je gebruikt is 11pt. Verwijzingen en/of voetnoten dienen steeds op dezelfde wijze te zijn aangegeven.
Algemeen	Wanneer je informatie van Internet haalt let dan op het volgende: letterlijk kopiëren van Internet is niet goed. Filter alle onnodige informatie er tussenuit en geef duidelijk antwoord op de vragen, niet meer en niet minder. Bewaar zelf altijd een digitale kopie van de instructie. Op deze manier heb je altijd een back-up van jouw document en kun je dit document later gebruiken als referentie materiaal.

Beoordeling communicatie

Tijdens het beoordelen van de communicatie wordt er op de volgende punten gelet:

• Zijn er vooraf afspraken over onderlinge normen en waarden gemaakt?
• Hoe is er met problemen om gegeaan?
• Welke communicatiemiddelen zijn er gebruikt?
• Hoe is de samenwerking verlopen?
• Voelen de teamleden zich serieus genomen?
• Is een ieders mening en idee welkom?
• Is er voldoende motivatie- of vaardigheid?
• Worden hoofd- en bijzaken herkend?
• Is er gebruikt gemaakt van LSD:)(Luisteren, Samenvatten en Doorvragen)

Kerntaak 1: Ontwerpen van de applicatie, (cross)media-uiting

De volgordelijke plaats van de documenten binnen het proces:

Behoefteanalyse --------> Functioneel ontwerp --------> Technisch ontwerp ------------->
Plan van aanpak --------------------------------------------------------------------------->

Bovenstaande betekent dat werkproces 1.2 parallel loopt aan de andere werkprocessen en van invloed is op alle te schrijven documenten binnen kerntaak 1.

Werkproces 1.1 Stelt de vraag en/of informatiebehoefte vast

Doel: Verwachtingen afstemmen
Input: Projectbeschrijving/Briefing/RFP
Output: Schriftelijk advies/Offerte
Beoordeling: Projectbegeleider vervolgens opdrachtgever
Voor wie: Opdrachtgever

Vragen die gesteld moeten worden

Hieronder staan een aantal voorbeeldvragen, onderverdeeld in groepen. Zowel de vragen als de groepen zijn niet absoluut. Het gaat erom dat je na je gesprek een duidelijk beeld hebt van de vraag van de klant.

	Uitleg:
Het is handig te beginnen met wat algemene vragen:	Wat is de aanleiding? Wanneer moet het af zijn? Noem vijf tot tien termen/woorden die van toepassing moeten/kunnen zijn op de toekomstige applicatie/website.
Natuurlijk wil je weten wat het doel is en wie de doelgroep is:	Wat wilt u met de applicatie bereiken? (Nieuwe klanten aantrekken, producten verkopen, imagoversterking, bepaalde omzet halen) Welke boodschap moet de website vertellen? Wanneer is de website een succes? Welke taken wilt u dat een websitebezoeker uitvoert?
Vervolgens moet je weten hoe een en ander eruit gaat zien, de zogenoemde ‘look and feel’:	Wat voor gevoel moet de gebruiker krijgen? Beschrijf de gewenste uitstraling. Moet er een bepaalde huisstijl gebruikt worden? Werk met voorbeelden van bestaande applicaties/websites en laat er commentaar op geven.
Ook wil je weten welke functionaliteit er moet zijn:	Welke informatie moet de applicatie/website bieden? Welke informatie moeten gebruikers krijgen? Moeten er berichten worden getoond? Om wat voor soort berichten gaat het en hoe vaak komen ze voor? Moet de gebruiker kunnen zoeken? Wie beheert de content en wie levert deze aan? Wie is verantwoordelijk voor de redactie? Is er een koppeling met sociale media en wie is hier verantwoordelijk voor?
Vragen over onderhoud:	Wie is verantwoordelijk voor het onderhoud? Moet er gebruik gemaakt worden van een Content Management Systeem, zo ja, welk? Is er ervaring met een Content Management Systeem? Hoe moet het onderhoud (intern of extern) geregeld worden?

Werkproces 1.2 Maakt een plan van aanpak

Doel: Vastleggen wat je gaat doen
Input: Schriftelijk advies, !! Feedback van de opdrachtgever
Output: Plan van aanpak
Beoordeling: Projectbegeleider vervolgens opdrachtgever
Voor wie: Opdrachtgever en team

Plan van aanpak:

Toelichting

In dit onderdeel geef je achtergrondinformatie over het project. Je geeft een situatieschets en je omschrijft de aanleiding van het project. Vaak komt een project voort uit een probleem dat moet worden opgelost. Als dat zo is, dan omschrijf je hier het probleem en eventueel de oorzaken ervan. In dit onderdeel kun je ook de structuur van het plan van aanpak benoemen. Dat geeft de lezer duidelijkheid over wat hij kan verwachten. Let er op dat je de aanleiding niet verwart met de doelstelling, deze bespreek je pas onder het volgende kopje.

	Uitleg:
Situatieschets:	Korte bondige bedrijfsomschrijving In welke omgeving (sector, markt, afdeling etc.) speelt het probleem zich af?
Aanleiding:	Waar komt de vraag vandaan, wat is de reden van de opdracht?
Probleemanalyse:	Wat is het probleem? Waarom is het een probleem? Wanneer is het een probleem? Waar doet het probleem zich voor? Wie heeft het probleem? Hoe lang bestaat het probleem al? Wat zijn mogelijke oorzaken? Wat is de urgentie? Hoe groot is het probleem?

Doelstelling

Onder dit kopje vertel je wat je wilt bereiken met het project. Wat is het doel? Waartoe leidt het project? Het kan zijn dat een project meerdere doelstellingen heeft, noem deze dan allemaal. Vertel ook waarom het (voor de opdrachtgever) van belang is dat de doelen worden bereikt.

	Uitleg:
Doelstelling:	Waarom wordt dit project uitgevoerd? Wat is het belang van de opdrachtgever? Wie heeft welk mogelijk voordeel van uitvoering van dit project?

Omschrijving

	Uitleg:
Wat:	Wat wordt er opgeleverd (definieer dit in concrete en/of meetbare resultaten)?

Leden projectgroep

	Uitleg:
Wie:	Wie gaat het project uitvoeren? Wie zit er in het ontwikkelteam? Wie is jouw projectleider? Wie is de opdrachtgever? Documenteer van een ieder de naam, emailadres en functie.

Benodigdheden

	Uitleg:
Waarmee:	Waarmee is dit project te realiseren? Denk aan werkplek, vergaderplek, voorzieningen, hardware en software

Takenlijst

	Uitleg:
Hoofdtaken:	Beschrijf de hoofdtaken in dit project? Denk aan ontwerpen, realiseren, implementeren en beheren
Begin- en einddata:	Noteer jouw inschatting van de begin- en einddata voor elke hoofdtaak? En geef in uren aan hoeveel tijd hiermee gepaard gaat.

Planning

Als laatste neem je in je plan van aanpak een projectplanning op. Zo verdeel je de taken onderling. In de planning staat overzichtelijk (vaak schematisch) aangegeven wie wat wanneer doet. Wees kritisch en zorg dat je geen onderdelen vergeet. Je neemt bijvoorbeeld ook in de planning op wanneer er geëvalueerd wordt of er een overleg gewenst is.

	Uitleg:
Subtaken:	Beschrijf de subtaken om de hoofdtaak ontwerp op te kunnen leveren, denk aan dit PvA, FO en TO
Begin- en einddata en tijden:	Noteer jouw inschatting van de begin- en einddata en tijden voor elke subtaak? En geef in uren aan hoeveel tijd hiermee gepaard gaat.
Betrokkenen:	Documenteer wie er voor de subtaak nodig is.
Oplevering:	Documenteer op welke manier de subtaak wordt opgeleverd, denk aan op papier, digitaal of overleg/presentatie.

Werkproces 1.3 Levert een bijdrage aan een functioneel ontwerp of Game Design Document

Doel: Vastleggen hoe je het gaat doen vanuit de gebruikers
Input: Schriftelijk advies en PvA
Output: Functioneel ontwerp
Beoordeling: Projectbegeleider vervolgens opdrachtgever
Voor wie: Opdrachtgever en team

Functioneel ontwerp:

• Doelgroep/Eindgebruikers > Wie zijn ze?, wat verwachten ze, hoe benaderen we ze
• Eisen omzetten naar functionaliteiten/userstories
• Per functionaliteit/userstory een wireframe of klikbare prototype
• Sitemap/Menustructuur
• Stroomdiagram van een belangrijke functionaliteit/userstory
• Opzet van een acceptatietestplan uit te voeren in KT2
• Eenvoudige beschrijving van afhankelijkheden van andere systemen/bronnen/diensten/API’s/sites

Werkproces 1.4 Maakt een technisch ontwerp

Doel: Vastleggen hoe en waarom je het gaat doen vanuit de techniek
Input: Schriftelijk advies, Functioneel ontwerp
Output: Technisch ontwerp
Beoordeling: Projectbegeleider
Voor wie: Teamleden en nieuwe medewerkers

Technisch ontwerp:

• Per complexe functionaliteit/userstory een wireframe met gedetailleerde uitwerking
• Toelichten van de gekozen oplossing(en)
• Database ontwerp/model / Entity Relation Diagram / Type velden
• Sequence diagram van een complexe functionaliteit/userstory
• Volledige beschrijving van afhankelijkheden van andere systemen/bronnen/diensten/API’s/sites

Werkproces 1.5 Richt de ontwikkelomgeving in

Doel: Inzicht verkrijgen van OTAP omgevingen
Input: Functioneel Ontwerp en Technisch Ontwerp
Output: Resultaat opnemen in het technisch ontwerp
Beoordeling: Projectbegeleider
Voor wie: Teamleden en nieuwe medewerkers

Beschrijving inrichting van ontwikkelomgeving:

• Welke ontwikkelomgeving er gebruikt gaat worden
• Welke taal ga je gebruiken
• Welke hulpmiddelen heb je nodig
• Hoe pak je de inrichting aan en is het gelijk aan de productieomgeving

Kerntaak 2: Realiseren van de applicatie, (cross)media-uiting

Werkproces 2.1 Legt een gegevensverzameling aan

Doel: Aantonen van kennis van het bewerken en analyseren van data
Input: Functioneel Ontwerp en Technisch Ontwerp
Output: Digitaal formaat met data
Beoordeling: Projectbegeleider
Voor wie: Teamleden

Fysiek bewijs in digitaal formaat:

• Database aanmaken
• Back up/dump van database
• Database moet op zijn minst gevuld zijn met voorbeeld data

Werkproces 2.3 Realiseert een (cross)media uiting en/of systeem

Doel: Aantonen dat je in staat bent om te programmeren volgens documentatie en planning
Input: FO, TO en planning
Output: Digitaal formaat met data, screenshots van het systeem en een realisatieverslag
Beoordeling: Projectbegeleider
Voor wie: Teamleden

Fysiek bewijs in digitaal formaat:

• Gehele back up van project
• Moet gevuld zijn met voorbeelddata
• Opgenomen in versiebeheer
• Screenshots van het systeem (applicatie en database)
• Conventie en documentatie

Realisatieverslag:

• Persoonlijke logboek in verhaalvorm
• Wat ging goed of fout -> noem voorbeelden

Werkproces 2.5 Test het ontwikkelde product

Input: Testplan uit het Functioneel Ontwerp en TO
Output: Acceptatietestrapport
Beoordeling: Projectbegeleider
Voor wie: De opdrachtgever

Acceptatietestrapport:

• Beschrijving van wat je gaat testen zoals beschreven in FO
• Overzicht van testers en hun inzet
• Uitvoeren van de test
• Screenshots van het testen (eventuele foutmeldingen)
• Verzamelen testresultaten en verbeteringen beschrijven
• Uitvoeren van de verbeteringen

Werkproces 2.6 Optimaliseert de game of (cross)media-uiting

Input: Acceptatietestrapport
Output: Optimalisatieplan
Beoordeling: Projectbegeleider vervolgens opdrachtgever
Voor wie: Opdrachtgever en teamleden

Optimalisatieplan:

• Gebruiksvriendelijkheid rapport
• Toegankelijkheid rapport
• Overzicht zoekmachine instellingen

Werkproces 2.7 Bewaakt de voortgang en evalueert het project

Input: Plan van aanpak en teamvergaderingen
Output: Actuele gedetailleerde activiteitenplanning en Evaluatie
Beoordeling: Projectbegeleider
Voor wie: Opdrachtgever en teamleden

Actuele gedetailleerde activiteitenplanning:

• Teamleden
• Tijdindeling
• Meetpunten

Evaluatie

• Verzamelen teamfeedback betreft jouw eigen inzet en verbeterpunten beschrijven

Kerntaak 3: Implementeren van de applicatie of (cross)media-uiting

Werkproces 3.1 Maakt of levert een bijdrage aan het implementatieplan

Input: De gerealiseerde applicatie
Output: Implementatieplan en presentatie
Beoordeling: Projectbegeleider en opdrachtgever
Voor wie: Systeem- en/of Applicatiebeheerder van de productieomgeving

Implementatieplan:

Beschrijf het volgende:

• Ingrijpende veranderingen in de organisatie
• Hoe en wie de gegevens gaan converteren, importeren of invoeren
• Procedures en verantwoordelijkheden
• Uitrol(deploy) aanpak(big bang, gefaseerd, parallel, gecombineerd?)
• Stappen in de vorm van een draaiboek op basis van tijd
• Alle te installeren hard- en software
• Infrastructuur, Servers(Web, DB, Mail etc.) en modules
• Systeemtest
• Beheerders training bij ingrijpende veranderingen
• Te verwachten toekomstige applicatie-, gegevens- en technisch beheer

Presentatie hand-out

• Presentatie van het implementatieplan aan projectbegeleider, opdrachtgever en betrokken medewerkers

Werkproces 3.3 Implementeert een applicatie of (cross)media-uiting en/of -systeem

Input: Implementatieplan
Output: Implementatierapport
Beoordeling: Projectbegeleider
Voor wie: Systeem- en/of Applicatiebeheerder van de productieomgeving

Implementatierapport:

• Uitvoeren en documenteren van installatie volgens implementatieplan in samenwerking met beheerder

Werkproces 3.4 Evalueert een implementatie

Input: Implementatieplan en uitkomst van implementatie
Output: Rapport met conclusies en verbeterpunten en procesverslag
Beoordeling: Projectbegeleider en opdrachtgever
Voor wie: Toekomstige beheerders en ontwikkelaars

Procesverslag van het gehele implementatietraject:

• Hoe verliep de voorbereiding
• Hoe verliep de uitvoering, denk aan: conversie, invoering, tijdpadbewaking, training, procedures hanteren, overdracht naar beheer

Rapport met conclusies en verbeterpunten

Kerntaak 4: Onderhouden en beheren van de applicatie, (cross)media-uiting

Werkproces 4.1 Onderhoudt applicaties of (cross)media-uiting

Input: Functioneel ontwerp
Output: Onderhoud- en beheerplan, Rapport over de uitvoering van het onderhoud
Beoordeling: Projectbegeleider en opdrachtgever
Voor wie: Systeem- en/of Applicatiebeheerders en toekomstige ontwikkelaars

Onderhoud- en beheerplan:

• Beschrijven, uitvoeren(en documenteren) van procedures voor:
• preventief onderhoud zoals updates, monitoring en unit-tests
• virus bescherming
• back-up en restore
• incidenten-registratie
• (nieuwe) eisen en wensen registratie
• Rapporteren van alle ondernomen stappen en vervolgacties aan opdrachtgever/projectbegeleider

Werkproces 4.2 Verzamelt, controleert, bewerkt en archiveert (cross)mediabestanden

Input: Alle projectdocumenten
Output: Resultaat opnemen in het onderhoud- en beheerplan en het archief
Beoordeling: Projectbegeleider
Voor wie: Toekomstige beheerders en ontwikkelaars

Archivering (procedures voor het archiveren van (gegevens van) applicaties):

• Toelichting gewenste format, type, kwaliteit en compressiefactor van de mediabestanden
• Analyse aangeleverde format, type, kwaliteit en compressiefactor van de mediabestanden
• Conversie mediabestanden

Archief:

• Digitaal formaat

Werkproces 4.3 Bewaakt de samenhang van media-uitingen

Input: De gerealiseerde applicatie
Output: Resultaat opnemen in het onderhoud- en beheerplan
Beoordeling: Projectbegeleider en opdrachtgever
Voor wie: Toekomstige beheerders en ontwikkelaars

Media-uitingen:

• Audio en visuele stijl samenhang controle(sluit de stijl aan bij andere media-uitingen van de opdrachtgever)
• Advies over andere (sociale)media mogelijkheden

Werkproces 4.4 Stelt script samen ten behoeve van het samenvoegen van content

Input: De gerealiseerde applicatie
Output: Resultaat opnemen in het onderhoud- en beheerplan
Beoordeling: Projectbegeleider en opdrachtgever
Voor wie: Toekomstige beheerders en ontwikkelaars

Opmaak:

• Weergave en uitleg van gebruikte opmaak/gridsysteem/theme/template

Werkproces 4.5 Beheert de content

Input: Onderhoud- en beheerplan
Output: Resultaat opnemen in het onderhoud- en beheerplan en fysiek bewijs in digitaal formaat met screenshots van het systeem
Beoordeling: Projectbegeleider
Voor wie: Toekomstige gebruikers, beheerders en ontwikkelaars

Contentbeheer:

• Korte beschrijving van de route die content aflegt vanaf creatie tot publicatie
• Beschrijving van verdeling van rollen, rechten en verantwoordelijkheden
• Beschrijving van procedures/regels voor aanleveren van bruikbare content
• Gebruikershandleiding en instructies van de wijze waarop content in de applicatie(s) wordt bewerkt en ingebracht
• Bewerking van analoge naar digitale content (scannen, converteren, etc.)

Behoefteanalyse

Het Plan Van Aanpak

Functioneel ontwerp

Technisch ontwerp

Beschrijving van de ontwikkelomgeving