Bonjour,
Je prévois de rendre la documentation utilisateur que j’ai rédigée disponible sur mon application.
Quelle est la meilleure façon de procéder ? Idéalement, j’aurais aimé qu’on puisse chercher dedans et qu’il y ait par exemple des chapitres sur lesquels je pourrais renvoyer pour chaque objet.
Merci d’avance pour vos conseils !
Emmanuelle
On parle de la doc Markdown ou de la doc legacy PDF ?
Je parle d’une doc Word que j’ai rédigée à part et que j’aimerais intégrer à Simplicité. Je ne sais pas ce que sont les docs Markdown et legacy PDF, il y a de la doc dessus ?
Dans Simplicité tous les items de paramétrage principaux (objets, attributs, etc.) ont un attribut “commentaire” qui permet de les documenter (format Markdown).
Quand on publie la doc Markdown/HTML d’un module, on retrouve ces éléments dans le doc généré.
Ca évite de devoir faire de la doc ailleurs (et on est sûr que la doc reste à jour puisqu’elle est générée depuis le paramétrage) et il est facile de le publier.
Ex: Demo
PS: Historiquement cette doc générée était un PDF, il est un plus complet mais ne gère pas bien le format Markdown
PS: l’exemple de la doc de la démo est composite, c’est un “Document MD” avec du texte manuel + des tags pour substituer la doc auto des objets (avec les commentaires paramètrés) et les imagesdes modèles:
La doc “brute” Markdown/PDF du module s’affiche ici:
D’accord merci pour ces précisions, la doc du module ne convient pas à mon besoin je pense.
La doc que j’ai rédigée est une sorte de How To expliquant comment utiliser notre solution. J’y ai intégré des schémas etc. Idéalement il faudrait un bouton en haut pour accéder à l’aide, et puis des ancres dans la doc pour chaque chapitre dont je pourrait mettre le lien au niveau des différents objets.
OK votre doc Word vous pouvez toujours le charger comme ressource et ajouter un raccourci qui pointe sur l’URL de cette ressource. vos utilisateur pourront alors la télécharger (cf. HTMLTool)
Si vous voulez mieux intégrer votre doc dans une application web faites en plutôt un document HTML ou un PDF. Ces deux formats sont nativement gérés par les navigateurs contrairement à Word qui nécessite d’avoir le programme Word installé sur son poste ou de faire appel à un viewer externe (ce qui n’est généralement pas adapté à du “on premises”), bref c’est un très mauvais format pour de la doc “en ligne”.
Merci pour votre réponse !
Oui je pensais à un pdf mais le mieux est peut-être de le faire en HTML avec un raccourci en haut vers la doc générale et un lien par objet vers l’ancre correspondant à chaque chapitre.
Quelle est la meilleure méthode pour ajouter un raccourci ? Une action ?
Merci c’est parfait pour mettre une doc complète.
Au niveau des objets, j’ai l’impression que le mieux est d’utiliser les static help, ça me permet aussi d’insérer des images si j’ai bien compris.
Bonjour,
L’aide en ligne se paramètre également au niveau des traductions d’objet et d’attribut.
Chaque objet possède un contenu d’aide en ligne dans sa traduction, il est aussi possible d’y insérer un href vers une page HTML générale (ressource ou statique d’un wiki…)
Exemple pour la Cron, l’aide ouvre un lien vers une ressource HTML :
Bonjour,
Y a-t-il une limite pour les images dans les aides statiques ?
Car au bout de la troisième image j’ai le résultat ci-dessous
Merci !
La limite doit être la taille de l’attribut tsl_help (50000 mais ça peut être augmenté)
Par contre idéalement il ne faudrait pas inliner les images en base64 mais plutôt référencer des images statiques <img src=.../> sinon ça va nuire aux performances d’envoyer N Kb d’aide à chaque appel des metadata de l’objet
Ex:
Dans le cas ci-dessus LOGO est une ressource de type image associée à la disposition default
C’est-à-dire que ça va être appelé dès qu’on utilise l’objet même si on n’affiche pas l’aide ?
Car là j’ai des centaines d’images donc ça m’arrange de ne pas les uploader toutes une à une …
Oui les aides en ligne font partie des meta données de l’objet. Il faut leur garder une taille raisonnable.
Si vous avez une aide “lourde” il convient plutôt de renvoyer vers une page ad hoc <a href="..." target="_blank">...</a>. Cette page s’ouvrira alors dans un onglet à part. Cette page peut alors être une page HTML avec des images inlinées en base64 et stockée sous forme de ressource.
Rectification: l’aide longue statique n’est pas par defaut dans les méta data, elle est appelée à la demande quand on ouvre la popup d’aide. Donc dans votre cas il faut à priori juste augmenter la taille de l’attribut
This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.
