Forum général.cherche-logiciel Logiciel de gestion de doc technique

Posté par  (site Web personnel) . Licence CC By‑SA.
Étiquettes : aucune
2
27
juin
2018

Bonjour,
Dans mon boulot, je dois délivrer des infras à des clients. Pour cela on décrit l'infra dans un Doc. On fait éventuellement plusieurs aller retour avec des questions réponses. Puis on valide la demande. Ensuite chaque point de la demande est traité et fait l'objet d'une recette technique et d'une recette client. Enfin l'infra est mise en prod.

Tous les documents, échanges, validations ayant eux lieu dans la phase de build permettent de produire un cahier d'architecture décrivant l'infra, un PV de recette permettant de nous garantir contractuellement, un PV de recette interne, une doc pour l'astreinte, diverses pages de wiki, un schéma d'infrastructure, divers fichiers technique (terraform …).

Ce travail de dactylo/documentaliste copieur de données et spécialiste de Word ne me convenant guère, je songe gérer la question en formalisant un fichier texte avec un format structuré, versionné dans git et des moulinettes d’extraction des informations, pour générer les squelettes de ma documentation.

Toutefois s'il existait déjà un logiciel pour faire ça, ce serait idiot de ma part de réinventer le coller par clic du milieu dont Gnome essaye de nous priver depuis 20 ans.

  • # pas sûr d'avoir compris clairement ton besoin...

    Posté par  (site Web personnel) . Évalué à 4.

    Ce que tu veux faire c'est :

    • écrire une doc unique (le fichier structuré) à partir duquel un script générerait tous les documents officiels,

    Ou c'est plutôt :

    • écrire un meta-template qui permettrait de pre-générer les différents documents qui seraient alors « prêts à être remplis » ?

    Si c'est le premier cas, comme je l'imagine, il y a XML & XSL qui sont fais pour ce genre de chose :

    • tu structures l'info en XML
    • tu écris tes moulinettes en XSL et tu les appliques sur ton document XML unique.

    En faisant des transformations XSL, tu craches n'importe quel format «text-based».

    https://fr.m.wikipedia.org/wiki/Extensible_Stylesheet_Language_Transformations

    • [^] # Re: pas sûr d'avoir compris clairement ton besoin...

      Posté par  (site Web personnel) . Évalué à 2.

      Merci pour ta réponse. Je pense que j'avais bien peur de l'entendre. Mais effectivement c'est fait pour ça.

      Ce que je veux c'est que la donnée saisie soit ingéré et intégrée dans avoir à y revenir.

      Si on me demande la feature "envoyer des mails", il faut prévoir un test d'envoi dans la recette, il faut un calque SMTP dans le schéma, une sonde sur le taux de bounces, sur la réputation des ips, une documentation pour deplanter le truc, la décharge de responsabilité pour couper le flux sans préavis si le client spamme …

  • # un wiki ?

    Posté par  . Évalué à 3.

    au boulot ou avait un wiki,
    on saissisez nos infos en markdown, c'etait historisé, versionné, on savait donc qui avait changé quoi dans l'equipe,

    et le wiki permettait un export libreoffice/pdf pour pouvoir envoyer la documentation au client

    • [^] # Re: un wiki ?

      Posté par  (site Web personnel) . Évalué à 2.

      Ça répond effectivement à une bonne partie du problème.

      Par contre, le seul que je connais bien, dokuwiki, n'est pas très à l'aise avec les fichiers bureautique, en import, comme en export. Il existe des plugins mais très limités. Par ailleurs, il est compliqué de vérifier qu'un certain formalisme est bien respecté.

      Lequel utilisiez-vous ?

      • [^] # Re: un wiki ?

        Posté par  . Évalué à 2.

        faut que je verifie, mais je crois bien que c'etait Dokuwiki avec les plugins d'export.
        nous ne faisions pas d'importation de document,
        au mieux un lien vers le fichier deposer par le client (pdf ou odt, word, excel)

        tout nos productions passent par le wiki, formater par le wiki,
        et l'on fait des exports depuis le wiki en libreoffice/pdf pour donner au client.
        ca peut prendre un template libreoffice pour avoir les entetes de la société, etc

        quand le client renvoie la recette signée, on l'ajoute au wiki sous forme de lien, avec la legende 'recette signée'

        sinon finalement c'est peut-etre directement une GED (Gestion Electronique de Documents) qu'il te faut, pour gerer les flux, les droits, etc

        • [^] # Re: un wiki ?

          Posté par  . Évalué à 1.

          tu peux regarder du coté de panda doc pour transformer ton xml (.doc) en markdown

  • # question intéressante

    Posté par  . Évalué à 1.

    Je dirais une doc en html versionné avec git.
    Cela permet d'avoir une doc souple (facil à faire des liens et à éditer).
    Utiliser un wiki pour en faire un export parait effectivement une bonne idée.

Suivre le flux des commentaires

Note : les commentaires appartiennent à ceux qui les ont postés. Nous n’en sommes pas responsables.