La documentation est la clé

Meilleure pratique 2 - Complétez vos documents avant l'étape suivante

J'avais passé ma maîtrise en informatique et applications et j'étais tellement passionné d'écrire du code source même sans comprendre et documenter complètement les exigences. Le document de conception et la documentation des cas de test n'étaient nulle part dans le cycle de vie du développement logiciel ... il y avait un saut direct au codage.

Plus tard, je me suis retrouvé dans de gros problèmes et j'ai vite réalisé Documentation is the Key devenir développeur, testeur ou architecte de logiciels à succès.

Avant de commencer à développer un petit ou un gros logiciel, vous devriez avoir des réponses aux questions suivantes:

• Où est la spécification des exigences?

• Où est le document d'analyse d'impact?

• Où est le document de conception?

• Avez-vous correctement documenté toutes les hypothèses et limitations?

• Avez-vous examiné tous les documents?

• Avez-vous approuvé tous les documents de toutes les parties prenantes?

Une fois que vous avez des réponses positives à toutes les questions ci-dessus, vous êtes en sécurité et prêt à procéder au codage. De nombreuses organisations auraient des règles strictes à suivre, mais d'autres ne le seraient pas. La meilleure pratique consiste à remplir toute la documentation requise et à obtenir les approbations appropriées avant de procéder au codage du logiciel.

Ce que vous apprenez aujourd'hui, vous prépare pour demain!

Donc, encore une fois, c'est l'une des meilleures pratiques d'avoir autant de documentation que possible. Quelques documents importants qui vous prépareront pour l'avenir sont:

• Approches de conception
• Trucs et astuces
• Fonctions spéciales, commandes et instructions
• Leçons apprises
• Situations particulières
• Méthodes de débogage
• Les meilleures pratiques
• Tout ce qui peut vous aider à l'avenir

La conservation électronique des documents ne vous coûte rien. Commençons donc à maintenir la documentation requise.