La documentation de code et d'API est désormais passée du côté des fichiers sources. Des outils permettent d'en extraire les blocs documentaires, afin de maintenir toujours en phase le manuel et le code sans dupliquer l'effort. Or, un bon dessin valant mieux qu'un long discours, il devient plus nécessaire que jamais de pratiquer le Diagram as Code (DaC) pour incorporer des illustrations techniques directement dans les sources.
Nous avons tous apprécié l'article de Tristan Colombo [1] qui présente une collection d'outils fameux pour réaliser des illustrations. Néanmoins, tout le monde sait à quoi pourrait ressembler le camembert {142, 87, 58, 14}, et il serait ennuyeux, pour le représenter, de devoir dessiner un cercle et des secteurs un par un en prenant soin de calculer les angles en pourcentages de 360 pour correspondre au jeu de données.
Si les outils généralistes de dessin offrent tout ce que l'imagination peut souhaiter pour faire du cubisme désinhibé (parfois à l'efficacité pédagogique hasardeuse), ils peuvent s'avérer fastidieux pour tracer proprement un simple diagramme de classes bien standard, ou un schéma de base de données. Pire, une fois le dessin composé puis l'image collée dans le wiki, que doit-on versionner : l'image, au risque de devoir tout recommencer si l’on veut y changer une virgule ? Le fichier, souvent binaire, du logiciel de dessin ? Et même s’il est...
- Accédez à tous les contenus de Connect en illimité
- Découvrez des listes de lecture et des contenus Premium
- Consultez les nouveaux articles en avant-première