Vernieuwde projectdocumentatie, opgedeeld in een vijftal documenten.
- Projectplan (PP); Algemene informatie over jouw project.
- Programma van Eisen (PvE); De eisen en wensen van het product.
- Functioneel ontwerp (FO); Wat moet het product doen?
- Technisch ontwerp (TO); Welke technologieën gebruiken we?
- Visueel ontwerp (VO); Hoe ziet het digitale product er uit?
Lees de inleiding projectdocumentatie (PDF) door, zodat jij leert waarom en hoe we deze documentatie schrijven. Bekijk Markdown Guide als je wilt leren hoe je in Markdown documenten opmaakt.
Van de vijf documenten, hebben we .docx en .md templates beschikbaar gesteld, die je als basis kunt gebruiken om jouw eigen projectdocumentatie te schrijven. Onze voorkeur gaat uit naar Markdown, omdat dit gemakkelijk te lezen is zonder extra software zoals Microsoft Word of Acrobat Reader. Opmaak is wellicht wat beperkt, maar forceert je ook wat gestructureerder te denken/schrijven.
De documenten starten met de afkorting van de soort gevolgd door 'projectnaam', wat jij uiteraard kunt veranderen in de naam van jouw project. Zo kan je een in Markdown opgemaakt projectplan voor bijvoorbeeld klant 'Webshop Janssens' hernoemen naar pp-webshop-janssens.md. Alle overige documenten krijgen dan diezelfde projectnaam. Wel zo handig, vooral als je meerdere projectdocumenten beheerd.
Note
Deze templates zijn zeer uitgebreide versies van de te leveren documentatie. Heb je een kleiner project, dan gaan wij samen diverse onderwerpen schrappen. Doe dit enkel in overleg met jouw begeleider.
| Document | Bestandsnaam | Word | Markdown |
|---|---|---|---|
| Projectplan (PP) | po-projectnaam | .docx | .md |
| Programma van Eisen (PvE) | pve-projectnaam | .docx | .md |
| Functioneel ontwerp (FO) | fo-projectnaam | .docx | .md |
| Technisch ontwerp (TO) | to-projectnaam | .docx | .md |
| Visueel ontwerp (VO) | vo-projectnaam | .docx | .md |
De lesstof en templates zijn beschikbaar gesteld door Victor van der Put (@MakePixelsWork) middels zijn 'Websites leren bouwen' cursus materiaal. Vrijwel alle teksten komen van het internet, waardoor hier geen rechten aan ontleend kunnen worden.
Voor vragen en/of opmerkingen, weet men mij te vinden.
Victor van der Put
@MakePixelsWork