Bien documenter ses projets

La documentation technique est essentielle dans un projet. Cette liste propose diverses pistes vous permettant d'écrire et de générer simplement cette documentation.
Nombre d'articles :
9 article(s)
Type de liste de lecture
Tour d'horizon
Niveau :
Débutant

Tests et documentation, les deux piliers de tout projet !

Magazine
Marque
GNU/Linux Magazine
Numéro
201
Mois de parution
février 2017
Spécialité(s)
Résumé
Est-ce qu'un projet se limite au code qui le compose ? Non, bien entendu, mais nous avons toutes et tous tendance à bien trop souvent l'oublier. Même si bien entendu sans code, un projet n'est rien, et s'il n'y a rien d'autre que du code, comment le comprendre ou lui faire confiance ?

Utiliser un outil de génération de documentation avec Doxygen

Magazine
Marque
Linux Pratique
Numéro
117
Mois de parution
janvier 2020
Spécialité(s)
Résumé

Documenter du code est souvent une partie d'un projet qui peut paraître longue, fastidieuse, voire ennuyeuse pour certains. Néanmoins, cette étape est cruciale pour la compréhension et la maintenabilité du code. Depuis longtemps, des outils permettant de faciliter cette tâche existent. Cet article a pour but de présenter Doxygen, l'un de ces outils de génération de documentation, et les atouts qu'il peut apporter à ses utilisateurs.

Utiliser TeXmacs pour rédiger vos documents scientifiques

Magazine
Marque
Linux Pratique
Numéro
116
Mois de parution
novembre 2019
Spécialité(s)
Résumé

Écrire des formules, équations, tableaux, théorèmes, etc., tel est le quotidien des scientifiques, et la plupart du temps, ils se mordent les doigts avec les logiciels de traitement de texte LibreOffice Writer, Microsoft Word, pour ne citer que ceux-là... essayant tant bien que mal de produire quelque chose de scientifiquement présentable.

Créer vos documents scientifiques avec LyX

Magazine
Marque
Linux Pratique
Numéro
111
Mois de parution
janvier 2019
Spécialité(s)
Résumé

Lorsque vous désirez écrire des documents scientifiques intégrant de longues équations, les traitements de texte classiques comme LibreOffice ou Word trouvent très vite leurs limites. Il en est de même pour la gestion de la bibliographie, d’un glossaire et de la mise en page. La principale alternative est LaTeX. Cependant, de nombreux utilisateurs rechignent à apprendre un langage pour composer du texte. LyX est alors la solution, voyons comment le mettre en œuvre.

Écrivez et gérez vos documentations avec BookStack

Magazine
Marque
Linux Pratique
Numéro
110
Mois de parution
novembre 2018
Spécialité(s)
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.

Générez la documentation technique de vos projets Godot

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Spécialité(s)
Résumé

Découvrons comment utiliser GDScript Docs Maker pour générer automatiquement la documentation de vos projets Godot. Nous allons voir dans cet article que l’on peut simplement, à partir de notre code et de ses commentaires, avoir une documentation toujours à jour.