Dokumentation av nya funktioner och ändringar¶

Med varje Blender-version introduceras nya spännande funktioner, förbättringar och ändringar. För att säkerställa att Blender-användarna kan få ut mesta möjliga av dessa uppdateringar måste dokumentationen uppdateras parallellt.

Dokumentationsprojektet för Blender spårar ändringar som kräver uppdateringar eller tillägg till manualen. Genom att bidra hjälper du till att hålla manualen korrekt och värdefull för den globala Blender-gemenskapen.

I den här guiden går vi igenom processen för att dokumentera dessa ändringar med hjälp av release issues och commit logs.

Spåra ändringar med hjälp av releasefrågor¶

Varje Blender-utgåva har en associerad fråga i dokumentationsprojektets ”Upcoming Releases Project <https://projects.blender.org/blender/blender-manual/projects/28>`__. Dessa frågor innehåller en sammanställd lista över kodkommiteringar från Blenders utvecklingsprocess som introducerar förändringar som riktar sig till användaren. Dessa ändringar kräver vanligtvis uppdateringar av manualen, till exempel nya avsnitt, modifierade instruktioner eller uppdaterade skärmdumpar.

Steg för att bidra

Lokalisera utgivningsfrågan:
- Navigera till dokumentationsprojektets problemspårare och öppna problemet för den aktuella eller kommande Blender-versionen.
- Granska listan över åtaganden som anges i ärendebeskrivningen. Varje commit representerar en ändring eller funktion som behöver dokumenteras.
Välj ett åtagande:
- Välj en ändring som intresserar dig eller som stämmer överens med din expertis. Om du till exempel är bekant med modelleringsverktyg väljer du en ändring som är relaterad till dessa funktioner.
- Se till att ingen annan redan arbetar med samma uppgift genom att kontrollera kommentarerna eller statusuppdateringarna i frågan.
Förstå förändringen:
- Läs Commit-meddelandet:
  
  Commit-meddelanden sammanfattar ofta syftet med och omfattningen av ändringen. De kan länka till en pull request (PR) eller innehålla relaterade diskussionslänkar.
- Kontrollera PR eller kod:
  
  Den länkade PR ger ytterligare sammanhang, inklusive beskrivningar, bilder eller videor som förklarar funktionen. En genomgång av kodändringarna kan också hjälpa dig att förstå hur funktionen fungerar.
- Testa funktionen:
  
  Öppna Blender och testa funktionen för att se hur den fungerar. Denna praktiska erfarenhet kommer att klargöra hur funktionen beter sig och hur användarna kommer att interagera med den.
Räck ut handen om det behövs:
- Om commit-meddelandet eller PR inte ger tillräckligt med information kan du göra det:
  - Kontakta den som har utvecklat ändringen (användarnamnet finns vanligtvis i PR).
  - Ställ frågor på Blenders utvecklingskanaler eller forum.

Viktiga överväganden för dokumentation¶

Tänk på följande när du dokumenterar en ändring:

Vad är syftet?:

Förstå varför ändringen gjordes. Förbättrar den användbarheten, introducerar den en ny funktion eller löser den ett problem?
Vem gynnas?:

Fundera över målgruppen för inslaget. Är den avsedd för animatörer, modellbyggare eller någon annan användargrupp?
Hur fungerar det?:

Skriv tydliga och koncisa instruktioner. Inkludera praktiska exempel eller användningsfall när det är möjligt.
Leta efter beroenden:

Vissa ändringar kan vara beroende av andra funktioner eller påverka befintlig funktionalitet. Kontrollera om ändringen påverkar andra delar av manualen.
Skärmbilder och visuella bilder:

Om ändringen påverkar Blenders gränssnitt, ta skärmdumpar för att illustrera det. Se till att bilderna återspeglar rätt version av Blender.

Skicka in ditt arbete¶

När du har utarbetat dokumentationen:

Skriv i den manuella stilen:

Följ stilguiden för Blender-dokumentation för att säkerställa tydlighet och konsekvens.
Sänd in ditt bidrag:
- Open a pull request i dokumentationsprojektet.
- Hänvisa till release issue och commit i din PR-beskrivning.
- Inkludera alla skärmdumpar, diagram eller exempel som du har skapat.
Samarbeta:

Arbeta med granskningsteamet för att förfina din dokumentation tills den är redo att publiceras.

Varje bidrag är viktigt¶

Att bidra till Blenders dokumentation är ett givande sätt att stödja gemenskapen och se till att användarna förstår de senaste funktionerna. Genom att dokumentera dessa förändringar spelar du en nyckelroll i att göra Blender mer tillgängligt och roligt för alla.

Börja utforska releasefrågorna redan idag och hjälp till att förverkliga Blenders innovationer!