Forbedring av dokumentasjonen

TG har jobbet en god stund med å gjøre om dokumentasjonen til et mer dynamisk format. Alt skrives nå i Markdown, et Wiki-liknende tekstformat, og konverteres til HTML. De genererte HTML-sidene overføres fra Coderesort til buddysamarbeidet.no/docs/ når oppdateringer gjøres.

Fordelene med dette er

  • Vi får all dokumentasjonen på ett sted via web
  • Vi kan spore endringene enkelt i kildekode-treet/Coderesort

Vi vet at det er et stykke igjen til perfekt dokumentasjon, men håper dere er enige i at dette er et godt stykke i riktig retning. Utviklere vil få krav om å dokumentere direkte i Markdown framover.

Forøvrig vil vi gjerne ha hjelp med forbedringer i form av innspill eller konkret skriving.

Husk at det er mer matnyttig stoff om Buddy på Coderesort www.coderesort.com/p/buddy/wiki/WikiStart

 

Teknologigruppa