Project

General

Profile

Support #98

Compte rendu Documentation assessment du 14/05/09

Added by Jean-Baptiste Vergely almost 15 years ago. Updated almost 15 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
-
Start date:
05/15/2009
Due date:
% Done:

100%

Estimated time:
Close

Description

Dans la doc technique:
  • Cadre du projet.
  • Cadre technologique.
  • Description de l'environnement.
  • Description d'architecture (brique logiciel, comment l'implémenter ?).
  • Description des classes, interface, comment ca fonctionne ?
  • Tableau de référence documentaire.
  • Tableau des Bugs techniques connus (Par exemple, dans telle classe quand la fonction est appelé à cet endroit j'ai un bug).

Doc utilisateur:

  • Tableau des références documentaires.
  • Lien vers le site, le téléchargement de l'application.
  • Liste des bugs connus.
  • Mettre la FAQ complète dans la doc. Passe moyen quand c'est un lien web.

Site Web:

  • Outil de communication.
  • Doit être sympa visuellement.
  • On doit trouver les documentations, les livrables (les binaires je pense).
  • De quoi communiquer avec les utilisateur (RSS, forum, news).
  • Lien vers Epitech, référence aux EIP.

Also available in: Atom PDF