comment rédiger une bonne documentation
Forum Programmation : comment rédiger une bonne documentation
Je viens de finir mon application winForm mais je ne sais quoi ecrire dans la doc que je dois fournir avec celui-ci, car elle ne s'adresseras qu'a la personne qui devras relire le programme et non aux utilisateurs.
Shérif adjoint du FLCCF
Le FLCCF vaincra :)
écris la en sms c'est plus rapide.
Lol je peux pas me le permettre car cela compte pour mon rapport de stage.
Shérif adjoint du FLCCF
Le FLCCF vaincra :)
Répondre à s373n
qu'est ce que tu veux que l'on te dise ?
décris les fonctions dans le programme, à quoi elles servent, les arguments que tu fais passé etc ...
tu peut prendre exemple sur des applis que tu trouveras sur le net ...
A part d'etre claire et concis, il n'y a pas vraiment d'autre conseils à donner, va faire un tour sur developpez.com dans leur faq.
OK merci Okinou.
Shérif adjoint du FLCCF
Le FLCCF vaincra :)
Répondre à s373n
Ou alors fait carrément comme une vrai doc
Ragnarok Battle Offline
L'Ouvroir
Répondre à Dawlin
C'est-à-dire car je n'en n'ai jamais fais.
Shérif adjoint du FLCCF
Le FLCCF vaincra :)
Répondre à s373n
Ben en fait (corrige moi si je me trompe) :
tu as fait un logiciel
tu dois le présenter comme rapport de stage,
donc le donner a un "jury"
si tu leur donne un logiciel avec une doc qui leur explique ce que tu as fait, c'est pas vraiment ça. Ils attendent surement une doc comme si c'était un produit que tu vendais et qui était pour tous les NooBs qui n'arriveront a rien avec ton logiciel.
Mias peut-etre pas.
Si oui, sois tu essais de rédiger comme une personne qui métrise et qui est habituée a faire des docs, soit tu pompe un peu dans quelques logiciels pour savoir quelles tournures de phrases enployer ...
Ragnarok Battle Offline
L'Ouvroir
Répondre à Dawlin
Ah ok merci. Je pensais que c'étais plus compliqué que ça.
Shérif adjoint du FLCCF
Le FLCCF vaincra :)
Répondre à s373n
Il y a 333 utilisateurs connus et inconnus. Pour voir la liste des connectés connus, cliquez ici.
