Ontwerp en bouw een besturingssysteem/Organisatie/Minimale documentatie

De GNU hulpmiddelen en het bekendste open-source besturingssysteem Linux gaan hand in hand, en daarom is het handig om bepaalde conventies uit de GNU-wereld over te nemen. De minimale documentatiebestanden zijn daar een onderdeel van, en beschrijven wat het programma doet, hoe het werkt en geïnstalleerd moet worden, wie het hebben gemaakt en wat de bijbehorende licentie is.

Mocht je nu geen zin hebben om de hieronder breschreven README, AUTHORS, ChangeLog, NEWS en COPYING bestanden te schrijven, maak er dan op z'n minst lege bestanden voor aan.

Leesmij

Elk programma heeft een leesmij bestand nodig. Schrijf hierin een korte uitleg van het doel van het programma, en informatie die de gebruikers moeten lezen alvorens het programma te configureren en installeren. Noem dit bestand README (dus zonder extensie).

Een voorbeeld:

/README

Introductie
===========
MijnOS is een algemeen besturingssysteem voor thuis en kantoorgebruik.

Compilatie
==========
Zie INSTALL voor instructies.

Ondersteuning
=============
Bezoek ons op:
http://mijnos.example.com/

Nieuws

Het is handig om een bestand bij te houden met alle nieuwe features van elke uitgave. Dit gebeurt in het NEWS bestand, waarbij de beschrijving van de nieuwste versie steeds bovenaan wordt geplaatst.

Veranderingen logboek

De veranderingen worden bijgehouden in ChangeLog, eventueel in de mappen van de onderdelen.

Auteurs

Een lijst met auteurs, opgeslagen in AUTHORS.

Licentie

Bewaar de licentie in het COPYING bestand, en vergeet niet om bovenaan elk broncodebestand een korte licensietekst te plaatsen.