-
Documentation de site
Bonjour a tout le monde, je ne sais pas si c'est la bonne section pour poster mais elle s'en rapproche beaucoup.
Je cherche a faire une documentation utilisateur pour un site web (html/php).
J'ai chercher des outil de doc, mais que pour les programmeurs, pas pour les utilisateurs.
Existe-t-il un outil qui parserait tout les fichiers et pourrait créer une arborescence html qui reprendrait chaque page et chaque bouton pour afficher une doc de tout sa?
Je pense pas que sa soit faisable mais bon, dans le doute, je demande :)
Comme mon site possède plusieurs dizaine de pages, créer tout ça à la main me semble un peu galère. Sinon je ferais un petit programme en php qui reprend tout ça et génère une arborescence par page avec le détail et stocke dans une bdd leurs définition.
Mais comme on dit, autant ne pas réinventé la roue, surtout si elle tourne moins bien qu'une autre ;)
Je n'ai pas vraiment réussi a être très clair donc n'hésitez pas a me poser des questions ;) (J'ai un bon niveau en html et php donc pas de soucis pour créer un tel outil ;) juste un gain de temps si quelqu'un connait un outil existant)
-
Quels éléments veux-tu documenter ? Des fonctions PHP ? Des balises HTML ? Un truc farfelu ?
-
Hum un peu des trois ^^.
Mon code php est déjà bien documenté avec de joli commentaires de partout.
Mais ce que je voudrais le plus c'est afficher les pages html dans des miniature et expliquer le fonctionnement de chaque page avec ces bouton.
Donc si une appli permet déjà de créer les pages html reprenant mon site et détaillant chaque bouton (je n'aurais plus qu'a taper les descriptions de bouton) ça serait bien :)
-
Pour ce qui est du PHP, tu peux toujours regarder du côté de PHPdoc :
http://www.phpdoc.org/
Mais je ne connais aucun outil qui documente du code HTML .. Cela dit je ne prétends pas avoir la connaissance universelle et peut-être que quelqu'un a déjà fait ce projet.
-
Pour le code php, je le ferais manuellement je pense (pas de classe juste des petits script) donc faire une documentation ligne à ligne avec un outil de recherche.
Je suis en train de voir pour créer moi-même un outil de création de site documentaire en prenant des miniatures pour chaque page, tu saurais comment créer une miniature d'une page web? en passant par php évidemment :) du genre on accède a une page de ce type: http://monsite.com/miniature.php?page=index.php et ça retourne une miniature de la page créée
-
Je ne crois pas que ça soit possible en PHP, non.
-
Ok, j'ai trouvé la solution en passant par un script js pour récupérer le content d'une page html et l'insérer dans une div. Je cherche maintenant à neutraliser son contenu (supprimer les onclick, href etc). Il me reste juste un souci pour les submit : les transformer en bouton. Je cherche encore et si je ne peux pas, je supprime les lignes de formulaire. Ca sera peut-être plus simple. :)
-
Bon rectification apres plusieurs test, je reviens sur ma décision de trouver un autre système:
J'ai essayer d'afficher les pages en prenant des iframe, truc dans le genre mais ça pose plus de probleme que prévu.
La bonne technique serait peut-etre de reproduire le site mais sans le code php pour pouvoir naviguer dessus en mettant les explications des boutons?
Ou alors faire une documentation en word, mais je trouve ça bien moche non?