Documentatie

Student heeft documentatie geschreven die er op gericht is de code voor anderen binnen het team te hergebruiken

Wat heb ik gedaan?

Ik heb op meerdere plekken in mijn framework documentatie staan over hoe je het framework moet gebruiken, wat de verschillende functionaliteiten zijn en wat de verschillende stukken codes doen. Dit heb ik gedaan met een README op de github pagina zelf, commentaar in de code en voor de leraren een klein bestand waarin ik sommige dingen nog extra uitleg.

Waarom heb ik dat gedaan?

Omdat het voor andere ontwikkelaars bijna onmogelijk is om frameworks/libraries te gebruiken zonder documentatie. Als er uitleg en documentatie bij staat zijn mensen ook sneller geneigd om het ook daadwerkelijk te gaan gebruiken omdat ze minder tijd kwijt zijn met het zelf uitvogelen van de code.

Wat heb ik ervan geleerd?

Ik heb geleerd dat het documenteren van je code veel kan helpen. En dan bedoel ik niet alleen voor andere mensen, maar ook voor jezelf. Ik heb namelijk al een aantal keer meegemaakt dat ik tijdens het documenteren erachter kwam dit ik dingen was vergeten of dat ik ineens goede ideeën kreeg.
Daarnaast vond ik het ook best leuk om een README te maken voor op github, aangezien ik die heel vaak zie maar nooit bij had stilgestaan wat voor opmaak daarbij aan te pas kwam.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s