Documentation : trouver son style

Du code pour documenter du code, c'est ce qui a inspiré le choix de l'image de couverture (M.C. Escher, 1948 | "Comment dessiner des mains") pour cette session.

• Florian Strzelecki (profil LinkedIn) : architecte logiciel & expert Python chez Hellowork group

La documentation c'est comme le code, il y a des questions de style et la relecture est nécessaire. Que vous utilisiez Sphinx ou un autre outil / plateforme, le travail d'édition et de structuration du contenu reste le même. Du ton à adopter à la longueur des paragraphes, en passant par la liste des expressions à éviter, cette présentation sera l'occasion de plonger un peu plus dans les techniques d'écriture de la documentation, avec des exemples à reprendre pour tout un chacun.

Cette présentation est destinée à tous les niveaux, quel que soit votre rôle dans la création de logiciels.

Merci à Zenika Rennes d'accueillir cette session au premier étage de la Grande Halle Oberthur ! Un apéritif convivial offert par l'association BreizhCamp clôturera la soirée : l'inscription est gratuite, elle permet de dimensionner l'apéro ; donc elle engage à venir ou à libérer sa place en cas d'indisponibilité soudaine 🙏
Accès

• arrêt Oberthur : bus ligne C5, Vélo Star
• vélo : 2 racks extérieurs couverts côté sud de la Grande Halle
• entrée nord de la Grande Halle Oberthur au 74A rue de Paris, entrer et monter à droite au premier étage

Cet évènement aura lieu en présence dans l'agence Zenika Rennes qui nous accueille (merci ! 🙏). L'évènement est ouvert à toute personne intéressée par ces sujets, dans la limite de la jauge de 35 personnes. Il n'y aura pas de direct en visio, mais une rediffusion sera disponible sur la chaîne YouTube du BreizhCamp quelques jours plus tard.
En cas d'accès PMR nécessaire, veuillez nous contacter directement en amont de l'évènement.