Documentation numérique simple

Rédigez et partagez facilement votre documentation et vos diagrammes.

(Ref: Kapsule 2)

Copie d'écran de la Kapsule 1

Présentation

  • Cette solution de documentation utilise "GRAV" pour la gestion de vos pages. Il s'agit d'une application web gratuite de gestion de contenu (CMS).
  • GRAV a été conçu pour avoir être facile à configurer et rapidement maitrisable.
  • GRAV est une puissante application qui vous permet de construire rapidement un espace de documentation complet.
  • Techniquement, GRAV est un "Flat-file CMS". C'est à dire qu'il n'utilise pas de base de données de type MySQL ou MariaDB comme d'autres CMS tels que Wordpress. Il est ainsi plus léger, plus facile à installer, à maintenir et plus sécurisé.

Compétences techniques requises

Environnement nécessaire

Pour fonctionner, GRAV nécessite un hébergement composé:

  • d'un serveur web (Apache ou Nginx par exemple),
  • d'un langage de programmation nécessaire à la génération des pages Web dynamiques de GRAV (PHP).

Cet environnement peut être installé par vos soins sur votre propre matériel (Linux, Mac, Windows) ou directement loué chez un hébergeur.

Depuis la documentation officielle, vous serez renseigné(e)s sur les configurations requises.

Vous pouvez également nous contacter pour plus d’informations.

Installation de GRAV

  • Téléchargez gratuitement GRAV depuis le site officiel du projet.
  • GRAV est proposé au téléchargement en plusieurs versions:
    • GRAV Core: Vous téléchargez seulement le site web sans l'outil pour l'administrer (déconseillé si vous débutez).
    • GRAV Core + Admin plugin: Vous téléchargez le site web avec l'outil graphique pour l'administrer (conseillé).
    • Skeletons: Des paquets incluant le site web, éventuellement l'outil d'administration, le thème et la configuration des premières pages déjà effectuée (conseillé).
    • Themes: Vous téléchargez le site web avec un thème de votre choix, sans configuration déjà effectuée (conseillé).
  • Dézipper l'archive téléchargée et placez son contenu sur votre hébergement. Appliquez-y les droits nécessaires.

Utilisation de GRAV

  • Depuis votre navigateur web, rendez-vous à l'adresse de votre hébergement ou au sous-dossier si vous en avez créé un, par exemple: https://votresiteweb.ch ou https://votresiteweb.ch/grav.
  • Suivez la procédure d'installation que GRAV vous propose pour configurer votre site. Pour plus d'informations, vous pouvez consulter la documentation officielle.
  • Si votre espace de documentation ne doit contenir que du texte et des images, votre site est prêt.
  • Si vous avez besoin de présenter des diagrammes, des schémas ou des workflows, installez le plugin "Mermaid", depuis la section "Plugins" de GRAV. Mermaid vous permettra de générer directement depuis vos pages de nombreux types de diagrammes en format vectoriel (SVG). Pour vous familiariser à la génération de ce type de diagrammes et au langage Mermaid, veuillez consulter la documentation officielle de Mermaid ou découvrir Mermaid depuis notre article sur le sujet.

Informations importantes

Autre solution disponible pour créer votre documentation.

Si vous souhaitez disposer d'une plateforme de documentation professionnelle, allant au delà de plusieurs centaines de pages et qui intègre des diagrammes complexes, prenez le temps de découvrir la Kapsule 7. Cette Kapsule sera peut-être encore plus adaptée à votre besoin.