Bonjour,

Dans le cadre de mes études, je doit rédigé un rapport technique. J'ai pensé que, pour faire PRO et pour avoir une première expérience de redaction d'une doc tech, tourner mon rapport technique a la maniére d'une documentation tech serait un bon point pour l'obtention d'une note plus que correct.

J'aimerai donc savoir si vous avait un tuto qui explique comment rédigé une doc tech? qu'est-ce qu'il faut y joindre? des diagrammes oui mais les quelles? quelle detail faut-il mentionner? comment le structuré? ....

Merci d'avance.

Cordailement Therage Kevin.

-
Edité par theragekevin 4 juin 2015 à 14:42:36

Qu'appelles tu un document technique? parce que pour moi un doc tech c'est un doc produit en vu de l'usinage d'une pièce ou de la réalisation d'une carte électronique... soit un doc avec nomenclature, dessin technique etc.

Bonjour coxinette,

finalement, Le monde d'OpenClassroom est petit .

Et Euh bah en faite pour la Doc Tech je pense a un document qui faciliterai la reprise ou l'évolution de l'application web que j'ai développer par d'autre utilisateurs ou développeurs.

Un truc technique mais pas trop qui dit comment ça marche bref un truc qui fassent pro pour que la prochaine personne qui développe des truc sur l'appli (si il y en a une) comprenne rappidement ce que j'ai fait et puisse bidouiller facillement. Ce serait pour un publique plutôt averti mais pas trop ça fait partie du rapport de stage .

Salut !

La documentation du code doit être générée automatiquement en général, tu utilises quel langage ?

En gros un genre de cahier des charges quoi...

Re-Bonjour,

Désolé de répondre si tard un gros coup de bourre en ce moment (phase de pré-prod).

Alex-Easton :

J'ai tenu compte de t'a remarque pertinente. Je sais qu'il existe la possibilité de généré une JavaDoc mais .... c'est pour java moi la c'est du PHP enfin ... Symfony2 (a ce niveau c'est plus du php c'est un langage a part entière).

coxinette :

Euh, mouais ..., enfin en truc plus technique qu'un cahier des charges ... Genre impression d'ecran(HTML)  => découpage part fonctionnalitée => impression ecran du code ...

Bref, n'importe quoi fasse Technique et compréhensible.

Merci encore,

Cordialement Therage Kevin

Salut,

un document de spécifications ? Où tu intègre des diagrammes UML avec les cas d'utilisation, diagramme de signaux, diagrammes de classes participantes, modèle du domaine ? Planning

Ou si tu veux être plus près du mode agile, tu peut plutôt parler de user story et intégré a ton planning les itérations de sprint en expliquant ta démarche ?

-
Edité par Elored 17 juin 2015 à 11:32:06

Bonjour Kiisuk,

Merci ça a l'air sympa comme truc mais je vais abandonner l'idée (j'ai 2 jours pour le faire sans compté que je suis censé bossé dessus).

Merci a tous.