Écrivez et gérez vos documentations avec BookStack

Magazine
Marque
Linux Pratique
Numéro
110
Mois de parution
novembre 2018
Domaines


Résumé
La documentation, sa rédaction et son contenu, sont souvent repoussés en fin de projet. Alors que c’est souvent le plus important pour vos utilisateurs : une documentation inexistante ne motivera personne à utiliser votre projet. Une documentation obsolète frustrera votre communauté et fera fuir de potentiels nouveaux utilisateurs. La bonne documentation de votre projet, au même titre que son utilité et sa qualité, fait partie intégrante de sa réussite. Il existe déjà plusieurs solutions, dédiées et souvent complexes, ou d’autres qui détournent des applications CMS ou Wiki. Dans cet article, nous allons découvrir BookStack.

1. Introduction

BookStack [1] est une application web minimaliste pour rédiger, gérer et publier votre documentation. Minimaliste, car elle se concentre sur la documentation, et n’est pas pensée pour gérer une large sélection de types de contenus différents comme d’autres CMS ou wikis existants. Minimaliste, car elle offre une expérience utilisateur intuitive : un nouvel utilisateur ne sera pas submergé par une tonne d’options et menus, et pourra facilement commencer à utiliser l’éditeur WYSIWYG pour participer à la documentation, ou rechercher du contenu. Mais BookStack n’est pas simpliste pour autant : tout utilisateur avancé pourra utiliser Markdown pour la rédaction, gérer finement les droits d’accès ou encore personnaliser l’interface selon ses goûts personnels ou aux couleurs de sa société.

2. Installation

BookStack n’est disponible qu’en version 0.23, mais est tout à fait utilisable. BookStack...

Cet article est réservé aux abonnés. Il vous reste 90% à découvrir.
à partir de 21,65€ HT/mois/lecteur pour un accès 5 lecteurs à toute la plateforme
J'en profite


Articles qui pourraient vous intéresser...

Les différents frameworks de web scraping

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
114
Mois de parution
mai 2021
Domaines
Résumé

Il ne viendrait à l’idée à personne de nos jours de se lancer dans la récupération de données sur le Web sans s’appuyer sur un framework simplifiant la tâche et évitant de réinventer la roue (carrée). Voyons donc quelques outils indispensables permettant de mener à bien cette tâche.

Écrire des mathématiques en LaTeX

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
114
Mois de parution
mai 2021
Domaines
Résumé

S’il y a bien un domaine dans lequel excelle LaTeX, c’est l’écriture de formules mathématiques complexes et autres algorithmes. Une fois que l’on connaît et que l’on comprend la syntaxe, c’est très simple… encore faut-il avoir vu cela au moins une fois !

Application réseau avec Erlang : utilisation du protocole UDP

Magazine
Marque
GNU/Linux Magazine
Numéro
248
Mois de parution
mai 2021
Domaines
Résumé

La société Ericsson, pionnière dans le domaine des télécommunications, a été à l’origine de la création du langage Erlang. La bibliothèque standard offre toutes les méthodes pour gérer les connexions réseau, que ce soit pour créer son protocole au-dessus de TCP, UDP ou encore TLS, mais aussi en réutilisant des implémentations d’ores et déjà existantes au sein de l’écosystème fourni avec la release.

Neuropsydia : un module Python pour les neuropsychologues

Magazine
Marque
GNU/Linux Magazine
Numéro
248
Mois de parution
mai 2021
Domaines
Résumé

Il existe peu d’outils permettant de créer « simplement » du matériel d’évaluation neuropsychologique. Neuropsydia est un outil qui nécessite un minimum de connaissances en informatique, mais permet un gain de temps considérable, si l’on accepte d’écrire quelques lignes de code Python.