Opret en README til dit produkt eller projekt

En README-fil hjælper andre med at finde dokumentationen for dit produkt eller projekt – uanset hvor den ligger.

Indholdsfortegnelse

1. Sådan gør du
2. Skabelon

Alle OS2-produkter og -projekter skal have en README i deres offentlige Nextcloud-mappe. Det gælder også, hvis dokumentationen primært ligger på GitHub eller andre platforme.

Sådan gør du

1. Få overblik: Undersøg, hvor produktets eller projektets dokumentation findes.
2. Udfyld skabelonen: Beskriv kort, hvad man finder de forskellige steder. Indsæt links til relevante mapper og repositories.
3. Gem filen: Opret en fil med navnet README.md i den offentlige Nextcloud-mappe.
4. Hold den opdateret: Ret README-filen, når dokumentationsstrukturen ændres.

Hvis I også bruger GitHub, kan I med fordel indsætte et link tilbage til Nextcloud.

Skabelon

Kopiér skabelonen nedenfor, og tilpas den til jeres dokumentationsstruktur.

# [Produktets eller projektets navn]

Her finder du information om, hvor dokumentationen
for [navn] er placeret.

## Nextcloud

Her finder du:
- [Fx referater fra styregruppemøder]
- [Fx aftaler og regnskaber]

## GitHub

[Link til GitHub-repository]

Her finder du:
- [Fx kildekode og teknisk dokumentation]
- [Fx udviklingsplaner og registrerede fejl]

## Andre dokumentationssteder (hvis relevant)

[Beskriv eventuelle andre platforme, hvor dokumentation
findes, og indsæt relevante links.]

## Spørgsmål?

Kontakt [kontaktperson eller fælles kontaktmail].

---

**Senest opdateret:** [Dato]
**Ansvarlig:** [Rolle og evt. navn]

Hvis en dokumenttype ikke findes hos jer, kan I blot slette punktet. Det vigtigste er, at beskrivelsen afspejler, hvor dokumentationen faktisk findes.