2010-05-31 2 views
1

Je vais succéder à un développeur ici au travail bientôt. Par conséquent, je soutiendrai toutes les applications qu'il a écrites au cours des dernières années. Lorsque vous utilisez une application dont vous ne savez probablement pas grand-chose, quelle est la documentation la plus utile pour résoudre les problèmes, étendre les fonctionnalités, modifier les fonctionnalités, etc? Je pense qu'il faudrait vous donner un aperçu de ce que fait le logiciel, de ses interfaces avec d'autres logiciels, des bases de données qu'il utilise, des noms d'utilisateur, des mots de passe, etc.Quelle documentation est utile lors du support d'une application?

Existe-t-il un document de support logiciel? Les renvois à des modèles seraient très utiles.

BTW, malheureusement, il n'y a pas de documents d'exigences, les spécifications, etc! Donc, ma vraie question est la suivante: si mon collègue avait une journée pour écrire un seul document pour chaque application afin de pouvoir (plus facilement) le soutenir, quel serait ce document et/ou à quoi cela ressemblerait-il?

Répondre

1

Je demanderais principalement une sorte d'organigramme/schéma du fonctionnement de l'application.

Je voudrais être en mesure de savoir comment chaque fichier interagit avec d'autres fichiers (et la base de données). Donc, de cette façon, vous sauriez où commencer à corriger un bug ou ajouter une nouvelle fonctionnalité, etc.

Donc, pour faire un rapide mockup, le texte de celui-ci:


index.php - > login.php -> Dashboard.php

index.php: A boîte se connecter. Soumet se connecter à login.php dans

login.php: données avec les entrées de Vérifie base de données, indique l'erreur sur l'échec ou envoie à Dashboard.php

Dashboard.php: Une fois connecté cela agit en tant que menu principal


Quelque chose dans ce sens? Pour la documentation de base, je pense que c'est la voie à suivre.

Espérons que cela aide. Bonne chance!

Questions connexes