Documentació de canvis i noves funcionalitats

Amb cada distribució de Blender, s’introdueixen noves funcionalitats, millores i canvis emocionants. Per assegurar que les usuàries de Blender puguin aprofitar al màxim aquestes actualitzacions, cal actualitzar en paral·lel la documentació.

El projecte de documentació de Blender fa un seguiment dels canvis que requereixen actualitzacions o addicions al manual. Els qui hi contribueixen, ajuden a mantenir el manual precís i valuós per a la comunitat global de Blender.

Aquesta guia us duu de la maneta per tot el procés de documentar aquests canvis utilitzant les incidències de distribucions i els registres de submissions (commit logs).

Ús de les incidències de distribucions per al seguiment de canvis

Cada distribució de Blender té una incidència (issue) associada al projecte de documentació Projecte de distribucions imminents. Aquestes problemàtiques contenen una llista comissariada de les submissions de codi (=code commits) del procés de desenvolupament de Blender que introdueixen canvis orientats a la usuària. Aquests canvis normalment requereixen actualitzacions del manual, com ara seccions noves, modificació d’instruccions o actualització de captures de pantalla.

Passos per a contribuir

1. Localitzar la incidència d’una distribució:

   • Navegueu per la documentació del cercador d’incidències del projecte de documentació i obriu la incidència corresponent a la distribució actual o imminent de Blender.

   • Reviseu la llista de submissions que facilita la descripció de la problemàtica. Cada submissió representa un canvi o funcionalitat que requereix documentació.

2. Escolliu una submissió:

   • Seleccioneu una submissió (=*commit*) que us interessi o lligui amb els vostres coneixements. Per exemple, si esteu familiaritzades amb les eines de modelatge, trieu un canvi relacionat amb aquestes funcionalitats.

   • Assegureu-vos que ningú més ja està treballant en la mateixa tasca; això es fa revisant els comentaris o actualitzacions d’estat que té la incidència.

3. Copseu el canvi:

   • Llegiu el missatge de submissió:

     Els missatges de submissió sovint resumeixen el propòsit i l’abast del canvi. Poden enllaçar a un prec de captació o contenir enllaços de discussió relacionats.

   • Comproveu el :abbr:`PC (PR)` o el codi:

     El PC enllaçat facilita més context, incloent-hi descripcions, imatges o vídeos que expliquen la característica. Revisar els canvis de codi també us pot ajudar a entendre com opera la característica.

   • Posar a prova la característica:

     Obriu el Blender i proveu la característica per veure-la en acció. Aquesta experiència directa aclarirà com es comporta la característica i com les usuàries hi interactuaran.

4. Demaneu ajut si cal:

   • Si el missatge de submissió o el PC no faciliten prou informació, podeu:

     • Contactar amb la desenvolupadora del canvi (el seu nom d’usuària surt típicament al PC).

     • Fer preguntes als canals de desenvolupament o fòrums de Blender.

Qüestions clau de la documentació

En documentar un canvi, tingueu en compte el següent:

• Què pretén aconseguir?:

  Feu per entendre per què es va fer el canvi. Millora la usabilitat, introdueix una nova capacitat o soluciona un problema?

• A qui beneficia?:

  Penseu en el públic referent per a la funcionalitat. Està destinat a animadores, modeladores o un altre grup d’usuàries?

• Com funciona?:

  Escriviu instruccions clares i concises. Incloeu-hi exemples pràctics o casos d’ús sempre que es pugui.

• Busqueu dependències:

  Alguns canvis poden dependre d’altres funcionalitats o afectar una funcionalitat existent. Comproveu si el canvi impacta en altres parts del manual.

• Pantallades i il·lustracions:

  Si el canvi afecta la interfície de Blender, agafeu pantallades per il·lustrar-lo. Assegureu-vos que les imatges reflecteixin la versió correcta de Blender.

Presentació del vostre treball

Un cop redactada la documentació:

1. Escriptura en l’estil del manual:

   Seguiu la guia d’estil de documentació de Blender per garantir claredat i coherència.

2. Presenteu la vostra aportació:

   • Obriu un prec de captació al projecte de documentació.

   • Referencieu la distribució i la submissió en la descripció del vostre PC.

   • Incloeu-hi les captures de pantalla, diagrames o exemples que hàgiu creat.

3. Colaboreu:

   Col·laboreu amb l’equip de revisió per refinar la vostra documentació fins que quedi llesta per publicar.

Tota contribució és important

Contribuir a la documentació de Blender és una manera gratificant de donar suport a la comunitat i assegurar que les usuàries entenguin les últimes funcionalitats. En documentar aquests canvis, jugueu un paper clau per fer Blender més accessible i agradable per a tothom.

Comenceu a explorar les incidències de distribucions avui mateix i ajudeu a donar vida a les innovacions de Blender!