Documentation Handledning
Komma igång med dokumentation

versioner

Om dokumentation

Vad kan dokumenteras?

• Exempel på funktioner för olika språk.
• En kort introduktion av varje tagg.

Vad är skillnaden mellan en fråga och ett ämne?

• Ämnen har ett bredare räckvidd än frågor; dokumentation ämnen som ställs som en fråga kan stängas eftersom de är för breda.
• Ämnen bör ha flera exempel; en förfrågan som kan betjänas av ett ämne med ett enda exempel (t.ex. ett kodblock) är förmodligen för smalt.

Hej världen

Ett hejvärldsämne bör bestå av det mest grundläggande, kompletta, körbara startprogram som finns, som kan uppnås genom den största mängden versioner av språket, ramverket eller systemet som dokumenteras. Om det behövs bör anmärkningarna innehålla grundläggande instruktioner för hur man förbereder och utför exemplen.

Ämnet bör i allmänhet inte kräva mer än ett eller två exempel, utom i de fall där senare versioner av språket inte är bakåtkompatibla. Kom ihåg att hejvärldsämnet kommer att vara utgångspunkten för alla som just börjar lära sig ett språk. Som sådan bör det visa minsta arbetsexempel som en elev kan använda för att uppnå ett korrekt program. Det är inte nödvändigtvis en plats att demonstrera ett språkets senaste funktioner.