Page 1 sur 1
Comment rédiger un documentation technique ?
Posté : 02 mai 2006, 11:19
par SwiTz
Bonjour,
Voila une question qu'on ne pose pas souvent mais je voulais précisement ce qu'il faut mettre dans une documentation tecnhique pour une application web. Sera t il possible d'avoir un exemple ou schéma type.
Merci d'avance
Posté : 03 mai 2006, 18:47
par mere-teresa
Qui lira cette documentation ? Quelles informations souhaitera-t-il y trouver ?
Posté : 03 mai 2006, 19:22
par albat
Est-ce un manuel pour utilisateur (un mode d'emploi) ?
Ou est-ce un dossier technique destiné à celui qui assurera la maintenance ?
Posté : 04 mai 2006, 08:53
par SwiTz
Oui c'est un manuel destiné à l'installation et la maintenance de l'application. J'ai develloppé une appli qui sera hébergée par un entitée de mon entreprise. Donc ils auront besoin d'un manuel pour comprendre le fonctionnement de l'appli. Voila j'espère que cela réponds à vos questions
Posté : 04 mai 2006, 10:08
par mere-teresa
Bah, ça doit répondre à ta question, ne confonds pas tout, s'il te plaît 
Si c'est destiné à des gens qui devront savoir modifier l'application, ils aimeront trouver des informations
- sur le stockage des données (fichiers ? SGBD ?)
- sur l'architecture (organisation des répertoires, flux de données entre les programmes)
- le parcours utilisateur (quelle action déclenche quel retour, comment accède-t-il à ses données ?)
- le contenu des programmes (quel programme traite quelle partie de l'application ? Si je veux modifier telle fonctionnalité, dans quel fichier vais-je chercher ?).
Pour ma part, mes documentations contiennent la partie technique le schéma de la BDD, l'architecture (description arborescence et contenu répertoire), un tableau à 3 colonnes (nom du fichier, rôle, contenu) qui liste les fichiers par répertoire et par nom, avec leur rôle et les objets, méthodes et fonctions qui sont dedans, et un schéma UML avec les acteurs et leurs actions (les petits bonshommes), et la partie fonctionnelle : le schéma UML aussi, un joli schéma du parcours utilisateur, et un joli schéma du même parcours avec les noms de fichiers.
Si c'est destiné à des gens qui installeront l'application, ils voudront savoir la configuration à adopter, pour le serveur, les pré-requis (PHP4 ? PHP5 ? GD ?...etc), les actions à faire étape par étape (installation serveur, création bases de données, copie des fichiers, modifications des droits sur les répertoires, etc...)
Posté : 04 mai 2006, 11:38
par SwiTz
D'accord mnt je vois comment organiser ma doc technique, je te remercie pour ces conseils avisés