Rédaction doc technique et utilisation
Bonjour à tous,
Dans le cadre de mon stage et arrivant à la fin, je dois m'atteler à la rédaction des documentations de mon site web.
Ainsi, deux doc m'ont été demandé :
- Une doc technique
- Une doc d'utilisation
Donc la doc technique doit servir au prochain dev qui travaillera sur mon code. Et en cherchant un peu sur le net, j'ai vu que ma doc devait contenir ce qui suit :
- Structure BDD
- Arborescence des fichiers
Mais voilà, ça me semble un peu léger tout ça et je ne vois pas vraiment ce qu'il faut que je mette d'autre.. :?
Peut être l’interaction des fichiers avec la BDD ? (Pour ceux interagissant avec)
Interaction des fichier entre eux ?
Structure du site ?
Concernant la documentation d'utilisation, je ne comprends pas bien ce qu'elle doit faire.
Est ce une documentation visant à accompagner les utilisateurs ? C'est à dire lui décrire le site, son fonctionnent, comment effectuer les différentes actions disponible ?
Ou est ce autre chose ?
J'ai besoins d'un peu d'éclaircissement :) N'ayant réalisé ces documentations qu'en classe pour le moment, j'aimerai cette fois un rendu professionnel ! :mrgreen:
En vous remerciant d'avance.