Bonjour à tous,

J'ai réalisé un site avec le CMS Wordpress et le client me demande une documentation technique.

Que puis-je lui remettre en imprimé. Quelqu'un parmi vous l'aurait certainement déjà fait.

Merci d'avance...

5 réponses


qu'est ce que tu entends par doc technique? la doc devloppers? ou une doc technique d'utilisation?

doc developpeurs et technique d'utilisation.
Merci d'avance...

ben la doc devloppeurs c'est pas tres compliqué si tu as commenté ton code correctement j'entend par la comme ceci

/*
 * Nom fonction: par exemple
 * description fonction: un autre exemple
 * @return:  l'exemple d'un retour de fonction
/*

il suffit d'utiliser phpdocumentor avec la ligne de commande ca fait de superbes exemples

et la doc utilisateur ben tu fait un tuto de comment fonctionne ce que tu as fait, ca c'est pas tres compliqué a faire mais il n'y as pas d'outil qui t'aide vue que c'est toi qui fait une fonction nouvelle ou un environement nouveau.

Pour le doc utilisateur pas de soucis.
Je pensais trouver une doc technique en pdf quelque part destinée aux developpeurs. Si il faut donc le composer moi même, quel peut etre sa structure (ses composantes) ?
Merci d'avance...

ben c'est simple, il faut créer au dessus de chaque fonction / classe un bloque de commentaire phpdoc comme je t'ai mis en exemple et généré via une ligne de commande la doc php des toute tes fonctions.

Voila un exemple concret de la doc a faire pour l'extraire apres avec phpdocumentor.

 <?php
 /**
  * A summary informing the user what the associated element does.
  *
  * A *description*, that can span multiple lines, to go _in-depth_ into the details of this element
  * and to provide some background information or textual references.
  *
  * @param string $myArgument With a *description* of this argument, these may also
  *    span multiple lines.
  *
  * @return void
  */
  function myFunction($myArgument)
  {
  }

cette exemple vient directement du site de phpdocumentor. tu n'est pas obligé de le faire en anglais, le français marche aussi ^^