›

Rediger de la documentation technique

Am_MeAm_Me Membre
mai 2013 modifié dans Coin canapé & détente #1

Mon application bientot fini alors je voudrai rediger de la documentation : Ce que fait cette fonction pourquoi la ?


Je cherche a savoir si des personnes auraient des conseils a donner vis a vis de la redaction de la doc


Je ne savais pas ou poser cette question et je n'arrive pas a retrouver un post deja je crois sur ce forum.


 


Je connais un peu le latex mais vraiment tres peu mais s'il y a de l'aide, un tuto, ou des conseils je suis preneurs :D. S'il existe un logiciel qui simplifie le processus parfait


 


Et je rajouterai que la doc que je redige servira aux futurs developpeurs qui voudront completer mon application (je suis juste stagiaire actuellement)


Réponses

  • Alf1996Alf1996 Membre
    #2

    Peut-être ce post pourra t'aider ?


     


    http://forum.cocoacafe.fr/topic/10946-quel-outil-pour-faire-de-la-doc/#entry103357

  • CéroceCéroce Membre, Modérateur
    #3

    Pourquoi ne pas utiliser le traitement de texte utilisé dans la boà®te, voire un simple fichier texte ?


    De toute façon, tu ne vas pas perdre ton temps à  décrire des détails qui ne seront plus à  jour dès qu'un autre ira travailler dessus. C'est le code qui fournit les détails; là  tu vas exposer l'architecture dans les grandes lignes.


  • LarmeLarme Membre
    mai 2013 modifié #4

    Plusieurs questions me viennent :


    As-tu besoin de faire la doc réellement, où à  bien commenter ton code ?


    Avec au besoin, peut-être un p'tit fichier texte d'explication sur l'architecture globale si elle est complexe, mais là , l'organisation des fichiers et autres peut aider. Et si tu te bases sur des API diverses, comme un serveur externe, renvoyer vers celle-ci via un lien commenté dans le code peut-être intéressant, couplé peut-être avec une explication sur la trame reçue et son découpage, dans le cas où l'API changement et faciliter ainsi les futurs changements...


    Cette doc' servira uniquement au futurs développeurs sur le projet, ou également à  l'utilisateur (là  où on pense à  des manuels d'utilisations, même s'ils sont normalement à  proscrire sous iOS où tout doit être " intuitif ").


    Est-ce qu'il y a un Wiki dans ta boà®te ? Cela peut servir de base (respect des nomenclatures déjà  en place, etc.)


    Le format final doit être dans une format spécifique ?


  • Am_MeAm_Me Membre
    mai 2013 modifié #5

    @Alf1996 exactement ce que je recherchais


    @Ceroce Pas faux un simple traitement de texte suffirai mais bon je voulais faire de qq chose de lisible


     




    Plusieurs questions me viennent :


    As-tu besoin de faire la doc réellement, où à  bien commenter ton code ?


    Cette doc' servira uniquement au futurs développeurs sur le projet, ou également à  l'utilisateur (là  où on pense à  des manuels d'utilisations, même s'ils sont normalement à  proscrire sous iOS où tout doit être " intuitif ").


    Est-ce qu'il y a un Wiki dans ta boà®te ? Cela peut servir de base (respect des nomenclatures déjà  en place, etc.)


    Le format final doit être dans une format spécifique ?




     


    AH oui il y a un wiki !!! Quel idiot bon go sur wiki sur la page dediee


    Mais bon j'espere que ca pourra servir a quelq'un


     


    Merci a tous


Connectez-vous ou Inscrivez-vous pour répondre.