IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Conception Web Discussion :

Documentation de site


Sujet :

Conception Web

  1. #1
    Membre émérite
    Avatar de skeud
    Homme Profil pro
    Développeur informatique
    Inscrit en
    Juin 2011
    Messages
    1 091
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 34
    Localisation : France, Loire Atlantique (Pays de la Loire)

    Informations professionnelles :
    Activité : Développeur informatique
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Juin 2011
    Messages : 1 091
    Points : 2 724
    Points
    2 724
    Billets dans le blog
    1
    Par défaut 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)

  2. #2
    Modérateur
    Avatar de Bisûnûrs
    Profil pro
    Développeur Web
    Inscrit en
    Janvier 2004
    Messages
    9 906
    Détails du profil
    Informations personnelles :
    Âge : 41
    Localisation : France, Rhône (Rhône Alpes)

    Informations professionnelles :
    Activité : Développeur Web

    Informations forums :
    Inscription : Janvier 2004
    Messages : 9 906
    Points : 14 827
    Points
    14 827
    Par défaut
    Quels éléments veux-tu documenter ? Des fonctions PHP ? Des balises HTML ? Un truc farfelu ?

  3. #3
    Membre émérite
    Avatar de skeud
    Homme Profil pro
    Développeur informatique
    Inscrit en
    Juin 2011
    Messages
    1 091
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 34
    Localisation : France, Loire Atlantique (Pays de la Loire)

    Informations professionnelles :
    Activité : Développeur informatique
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Juin 2011
    Messages : 1 091
    Points : 2 724
    Points
    2 724
    Billets dans le blog
    1
    Par défaut
    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

  4. #4
    Modérateur
    Avatar de Bisûnûrs
    Profil pro
    Développeur Web
    Inscrit en
    Janvier 2004
    Messages
    9 906
    Détails du profil
    Informations personnelles :
    Âge : 41
    Localisation : France, Rhône (Rhône Alpes)

    Informations professionnelles :
    Activité : Développeur Web

    Informations forums :
    Inscription : Janvier 2004
    Messages : 9 906
    Points : 14 827
    Points
    14 827
    Par défaut
    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.

  5. #5
    Membre émérite
    Avatar de skeud
    Homme Profil pro
    Développeur informatique
    Inscrit en
    Juin 2011
    Messages
    1 091
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 34
    Localisation : France, Loire Atlantique (Pays de la Loire)

    Informations professionnelles :
    Activité : Développeur informatique
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Juin 2011
    Messages : 1 091
    Points : 2 724
    Points
    2 724
    Billets dans le blog
    1
    Par défaut
    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

  6. #6
    Modérateur
    Avatar de Bisûnûrs
    Profil pro
    Développeur Web
    Inscrit en
    Janvier 2004
    Messages
    9 906
    Détails du profil
    Informations personnelles :
    Âge : 41
    Localisation : France, Rhône (Rhône Alpes)

    Informations professionnelles :
    Activité : Développeur Web

    Informations forums :
    Inscription : Janvier 2004
    Messages : 9 906
    Points : 14 827
    Points
    14 827
    Par défaut
    Je ne crois pas que ça soit possible en PHP, non.

  7. #7
    Membre émérite
    Avatar de skeud
    Homme Profil pro
    Développeur informatique
    Inscrit en
    Juin 2011
    Messages
    1 091
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 34
    Localisation : France, Loire Atlantique (Pays de la Loire)

    Informations professionnelles :
    Activité : Développeur informatique
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Juin 2011
    Messages : 1 091
    Points : 2 724
    Points
    2 724
    Billets dans le blog
    1
    Par défaut
    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.

  8. #8
    Membre émérite
    Avatar de skeud
    Homme Profil pro
    Développeur informatique
    Inscrit en
    Juin 2011
    Messages
    1 091
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 34
    Localisation : France, Loire Atlantique (Pays de la Loire)

    Informations professionnelles :
    Activité : Développeur informatique
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Juin 2011
    Messages : 1 091
    Points : 2 724
    Points
    2 724
    Billets dans le blog
    1
    Par défaut
    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?

Discussions similaires

  1. Documentation sur site ecommerce
    Par soony dans le forum E-Commerce
    Réponses: 4
    Dernier message: 04/01/2007, 01h29
  2. Documentation technique d'un site
    Par joquetino dans le forum Général Conception Web
    Réponses: 4
    Dernier message: 17/08/2006, 01h42
  3. document de test d'un site web
    Par gloglo dans le forum Développement Web en Java
    Réponses: 2
    Dernier message: 27/07/2006, 18h37
  4. Site pour mettre en ligne des document à télécharger
    Par snoopy69 dans le forum Autres Logiciels
    Réponses: 4
    Dernier message: 24/01/2006, 20h59

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo