Discussion :

[joquetino]

Bonjour,

Dans le cadre d'un rapport, je dois réaliser une documentation technique d'un site Web développé. Ca reste assez vague pour moi tout ça, j'ai du mal à voir quelles notions je dois développer dans ce rapport. Auriez-vous des suggestions, ou pourquoi pas un exemple de documentation technique?

Le but, c'est de rédiger un rapport, non pas destiné à une personne susceptible de maintenir le site (donc pas besoin d'y inclure du code), mais à un professeur qui n'y connait rien en Informatique. Ca doit rester accessible.

Merci d'avance.

[Joe Le Mort]

deja la structure du site (s'il a une base de données)
Apres l'arboresence :
- exmple => le parcours d'un internaute : connexion, redirigié....blabla...

ce que font chaque page en général.

[Oluha]

je pense que tu dois faire une documentation qui explique comment fonctionne le site. Fais des captures d'écran, explique à quoi correspondent les différents écrans, les fonctionalités présentes sur chaque...

[soony]

Ce que tu souhaite réaliser, ca ressemble a un cahier de spécifications. Tu dois décrire les différents acteurs ou les groupes d'acteurs qui interviennent sur ce site ainsi que leur lien (quelles sont leurs droits, ou leurs fonctionnalités). Je sais pas si tu connait UML, mais je pense qu'il peut sérieusement t'aider (notamment pour les graphiques). Il te permet de formaliser le site. Tu peut par exemple établir des diagrammes de cas d'utilisations (ex: modiifer une fiche client, etc..) dans laquelle tu placerais tes différents acteurs et leurs actions... Enfin, tu peut faire un plan générale de toutes les pages avec pourquoi pas des screenshots. Bon courage

[joquetino]

Merci à tous pour vos réponses. Je vais creuser un peu tout ça, mais l'UML me semble une idée intéressante ...