Sortez votre oreiller préféré car il est temps de discuter de ce qui est le sujet le plus ennuyeux pour tout le monde - la documentation. Croyez-le ou non, au début des temps de développement, cela était une vraie et une importante livraison.
La documentation était (et est toujours dans certains secteurs) une profession à part entière. Quel est le but aujourd'hui ? Bien sûr, pour faciliter la compréhension du fonctionnement de l'application par les développeurs, avant de la modifier, et sans avoir besoin de passer des semaines à essayer de reconstruire le code à l'envers.
Je vais être très direct pour gagner votre temps. Il n'y a vraiment plus besoin de documentation détaillée. Si vous utilisez des frameworks standards, ceux-ci sont déjà documentés par ceux qui les maintiennent, et cela vous emmène déjà loin. Ensuite, personne ne la lira. Désolé, ils ne la liront pas.
Il est donc beaucoup plus judicieux de se concentrer sur la documentation des parties du code qui sont complexes, qui contiennent une logique d'affaires lourde et qui remplissent une fonction importante dans votre application.
Un document de 3 à 5 pages décrivant la fonctionnalité de manière générale, avec des détails sur les statuts ou ce qu'elle peut être, sera lu car il est complet et facile à comprendre rapidement.
Toute documentation doit être maintenue, donc une fois que vous avez fini de coder une logique complexe pour une fonctionnalité, il est bon de noter par écrit les choses les plus importantes à son sujet. Vous vous en remercierez plus tard.
Lisez-en plus dans "Le playbook du CTO" disponible sur Amazon/Kindle.
Nous aidons les entreprises avec leur technologie, en fournissant des services de CTO et de gestion de produits. Fidèles à nos services de CTO, nous travaillons avec des startups et des entreprises établies dans les pays nordiques, en Suisse et aux États-Unis.
Nous sommes une société suisse (LLC) basée en 
Suisse.