Aller au contenu principal

Rapports de documentation

Liberty Next → Documenter → Rapports de documentation rédige la documentation de l'installation telle qu'elle est — un livrable de projet, une passation, un audit de la configuration — en PDF ou en Markdown. Réservé aux superutilisateurs.

Vue d'ensemble​

Rapport d'implémentationRÉGLAGESLangueFrançaisEnglishLibellé de date (page de garde)par défaut : aujourd'huiTélécharger le PDFMarkdownCONTENU9 sections sur 11ContexteArchitectureApplications et menusÉcransConnecteurs et poolsTableaux de bord et ExplorateurExploitationSécuritéRéférentielsAnnexe : réglagesAnnexe : référence de l'APILangueet la date de couverturePDF ou Markdownsecrets masquésSections à cocherannexes à la demande

Les deux rapports​

RapportPourSections
Rapport d'implémentation — documentation technique et fonctionnelle de l'installationL'équipe projet, le client.Contexte, Architecture, Applications et menus, Écrans, Connecteurs et pools, Tableaux de bord et Explorateur, Exploitation, Sécurité, Référentiels ; à la demande, les annexes Réglages — toutes les valeurs, secrets masqués — et Référence de l'API.
Rapport technique — documentation développeurCeux qui maintiennent l'installation.Périmètre, Architecture, Modèle de données, Référence de configuration, Référence de l'API, Ligne de commande, Compilation et paquetage, Annexe : références dans le code.

En produire un​

  1. Ouvrir la carte du rapport.
  2. Cocher les sections — Toutes / Aucune — ; le compteur indique N sections sur M. Le rapport technique propose deux options : détailler chaque route de l'API, et inclure les extraits de code en annexe — long.
  3. Sous Réglages, choisir la Langue — Français ou English — et, au besoin, le Libellé de date de la page de garde ; par défaut, la date du jour.
  4. Télécharger le PDF, ou Markdown pour le retravailler.

Toute valeur dont le nom désigne un secret — mots de passe, clés, jetons — est masquée, de même que les adresses de connexion.

Voir aussi​