É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...

Conservez l’historique de vos commandes pour chaque projet, le retour

Magazine
Marque
GNU/Linux Magazine
Numéro
241
Mois de parution
octobre 2020
Domaines
Résumé

Pouvoir conserver un historique dédié pour chaque projet, voici l’idée géniale énoncée par Tristan Colombo dans un précédent article de GLMF [1]. Cet article reprend ce concept génial (je l’ai déjà dit?) et l’étoffe en simplifiant son installation et en ajoutant quelques fonctionnalités (comme l’autodétection de projets versionnés pour proposer à l’utilisateur d’activer un historique dédié, si ce n’est pas le cas).