Technical Documentation for Teams: READMEs, Runbooks, Diagrams, and Examples

Une session pratique de deux heures sur la documentation technique pour les équipes, axée sur les README, les Runbooks, les diagrammes et les exemples. Les participants travaillent sur des compromis d'ingénierie concrets, examinent des exemples et repartent avec une liste de contrôle qu'ils peuvent appliquer à leurs projets d'équipe réels.

Public : développeurs débutants et intermédiaires qui souhaitent une session d'ingénierie pratique, et non une présentation de langage.

Résultats :

• Expliquer les limites pratiques de la documentation technique pour les équipes
• Appliquer les README dans un petit exemple de travail
• Appliquer les Runbooks dans un petit exemple de travail
• Appliquer les diagrammes dans un petit exemple de travail

Format : deux heures avec une courte présentation de cadrage, un exemple concret, une discussion sur les compromis et une liste de contrôle de clôture pour la pratique.