Seuls les membres ayant 30 points peuvent parler sur le chat.

Forum Casio - Autres questions


Index du Forum » Autres questions » [Reverse-Engineering] Comment écrire de la documentation ?
LailouezzzHors ligneMembrePoints: 82 Défis: 0 Message

[Reverse-Engineering] Comment écrire de la documentation ?

Posté le 03/12/2019 19:59

Bonjour,


Après 1 semaines de recherche j'ai découvert assez de chose pour commencer une documentation, mais j'ai des difficultés dans ce genre de domaine (écrire / expliqué)
Avez vous des conseils à me donner ?


ZezombyeEn ligneRédacteurPoints: 1640 Défis: 13 Message

Citer : Posté le 03/12/2019 20:00 | #


- T'ouvres Microsoft© Word®™
- Tu écris

(tu as des difficultés avec quoi exactement ?)
Divers jeux : Puissance 4 - Chariot Wars - Sokoban
Ecrivez vos programmes basic sur PC avec BIDE
LailouezzzHors ligneMembrePoints: 82 Défis: 0 Message

Citer : Posté le 03/12/2019 20:01 | #


Zezombye a écrit :
(tu as des difficultés avec quoi exactement ?)

Tout ce qui est expression écrite, comment expliquer une fonction par exemple même si je comprends bien j'ai beaucoup de mal à exprimer/expliquer
LephenixnoirHors ligneAdministrateurPoints: 16421 Défis: 140 Message

Citer : Posté le 03/12/2019 20:04 | #


Premiers conseils : utilise un éditeur de texte, pas des formats zippés propriétaires.

L'exercice que tu as besoin de pratiquer semble être plus de l'écriture en général que pour la documentation. Ce que tu peux faire c'est ne pas hésiter à écrire beaucoup pour t'assurer que ce que tu veux décrire est effectivement dit. Tu pourras apprendre à être concis plus tard.

Pour le cas particulier des fonctions, tu peux donner des exemples, ou tout simplement paraphraser le code puis relire et expliquer de plus en plus l'idée générale et le pourquoi plutôt que le comment (remontée en abstraction).
LailouezzzHors ligneMembrePoints: 82 Défis: 0 Message

Citer : Posté le 03/12/2019 20:05 | #


Lephenixnoir a écrit :
Premiers conseils : utilise un éditeur de texte, pas des formats zippés propriétaires.

L'exercice que tu as besoin de pratiquer semble être plus de l'écriture en général que pour la documentation. Ce que tu peux faire c'est ne pas hésiter à écrire beaucoup pour t'assurer que ce que tu veux décrire est effectivement dit. Tu pourras apprendre à être concis plus tard.

Pour le cas particulier des fonctions, tu peux donner des exemples, ou tout simplement paraphraser le code puis relire et expliquer de plus en plus l'idée générale et le pourquoi plutôt que le comment (remontée en abstraction).

Merci, ça sera noté et appliqué

Planète Casio v42 © créé par Neuronix et Muelsaco 2004 - 2019 | Il y a 32 connectés | Nous contacter | Qui sommes-nous ? | Licences et remerciements

Planète Casio est un site communautaire non affilié à Casio. Toute reproduction de Planète Casio, même partielle, est interdite.
Les programmes et autres publications présentes sur Planète Casio restent la propriété de leurs auteurs et peuvent être soumis à des licences ou copyrights.
CASIO est une marque déposée par CASIO Computer Co., Ltd