Documenter de nouvelles fonctionnalités et modifications

À chaque version de Blender, de nouvelles fonctionnalités, des améliorations et des changements passionnants sont introduits. Pour s’assurer que les utilisateurs de Blender peuvent profiter de ces mises à jour, la documentation doit être mise à jour en parallèle.

Le projet de documentation Blender suit les modifications nécessitant des mises à jour ou des ajouts au manuel. En contribuant, vous aidez à garder le manuel précis et précieux pour la communauté mondiale de Blender.

Ce guide vous guidera tout au long du processus de documentation de ces modifications à l’aide des journaux de version et de commit.

Utilisation des publications de version pour suivre les modifications

Chaque version de Blender a une publication associée dans le projet de documentation Upcoming Releases Project. Ces publications contiennent une liste organisée des codes du processus de développement de Blender qui introduisent des modifications orientées utilisateur. Ces modifications nécessitent généralement des mises à jour du manuel, telles que de nouvelles sections, des instructions modifiées ou des mises à jour des captures d’écran.

Étapes pour contribuer

  1. Localiser la publication de la réalisation :

    • Accédez à la publication de la documentation du projet et ouvrez la publication pour la version actuelle ou à venir de Blender.

    • Passez en revue la liste des commits prévus dans la description du numéro. Chaque commit représente un changement ou une fonctionnalité qui a besoin de documentation.

  2. Choisir un commit

    • Sélectionnez un commit qui vous intéresse ou s’aligne sur votre expertise. Par exemple, si vous maîtrisez les outils de modélisation, choisissez un changement lié à ces fonctionnalités.

    • Assurez-vous que personne d’autre ne travaille déjà sur la même tâche en vérifiant les commentaires ou les mises à jour d’état dans le publication.

  3. Comprendre le changement :

    • Lisez le message du Commit :

      Les messages de Commit résument souvent l’objectif et la portée du changement. Ils peuvent être liés à une pull request (PR) ou contenir des liens de discussion connexes.

    • Vérifiez le PR ou le code :

      Le PR lié fournit un contexte supplémentaire, y compris des descriptions, des images ou des vidéos expliquant la fonctionnalité. Revoir les modifications du code peut également vous aider à comprendre le fonctionnement de la fonctionnalité.

    • Testez la fonctionnalité :

      Ouvrez Blender et testez la fonctionnalité pour la voir en action. Cette expérience pratique clarifiera comment la fonctionnalité se comporte et comment les utilisateurs interagiront avec elle.

  4. Demandez des précisions, si nécessaire :

    • Si le message de commit ou le PR ne fournit pas suffisamment d’informations, vous pouvez :

      • Contacter le développeur du changement (son nom d’utilisateur est généralement dans le PR).

      • Poser des questions sur les canaux de développement ou les forums de Blender.

Considérations clés pour la documentation

Lorsque vous documentez un changement, gardez à l’esprit ce qui suit :

  • Quel est le but ? :

    Comprendre pourquoi le changement a été apporté. Est-ce que cela améliore la convivialité, introduit une nouvelle capacité ou résout un problème?

  • Qui en profite? :

    Considérez le public cible de la fonctionnalité. Est-ce destiné aux animateurs, aux modélisateurs ou à un autre groupe d’utilisateurs?

  • Comment cela fonctionne? :

    Écrivez des instructions claires et concises. Incluez des exemples pratiques ou des cas d’utilisation lorsque cela est possible.

  • Recherchez les dépendances :

    Certaines modifications peuvent dépendre d’autres fonctionnalités ou affecter des fonctionnalités existantes. Vérifiez si le changement a un impact sur les autres parties du manuel.

  • Captures d’écran et visuels :

    Si le changement affecte l’interface de Blender, réalisez des captures d’écran pour l’illustrer. Assurez-vous que les visuels reflètent la version correcte de Blender.

Soumettez votre contribution :

Une fois que vous avez rédigé la documentation :

  1. Écrivez dans le style manuel :

    Suivez le guide du style de la documentation Blender pour assurer la clarté et la cohérence.

  2. Soumettez votre contribution :

    • Ouvrez une pull request dans le projet de documentation.

    • Référencez la publication de version et le commit dans votre description PR.

    • Incluez toutes les captures d’écran, diagrammes ou exemples que vous avez créés.

  3. Collaborez :

    Travaillez avec l’équipe de vérification pour affiner votre documentation jusqu’à ce qu’elle soit prête à être publiée.

Chaque contribution est importante

Contribuer à la documentation de Blender est un moyen gratifiant de soutenir la communauté et de garantir que les utilisateurs comprennent les dernières fonctionnalités. En documentant ces modifications, vous jouez un rôle clé en rendant Blender plus accessible et agréable pour tout le monde.

Dès aujourd’hui commencez à explorer les sorties de réalisation et aidez à donner vie aux innovations de Blender!