Bien documenter ses projets
Utiliser un outil de génération de documentation avec Doxygen
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
É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
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
Générez la documentation de vos APIs avec apidoc
Vous voulez documenter les APIs de votre projet, qu'il soit en Java, JavaScript, Python, etc. ? Ne cherchez plus et adoptez apidoc pour séduire vos utilisateurs ou vos clients !
Générez la documentation technique de vos projets Godot
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.
Gérez votre documentation projet comme du code
La documentation d'un projet, qu'il soit libre ou non, est encore souvent vue aujourd'hui comme la dernière roue du carrosse : on la gère si on a le temps et en vrai si on en a vraiment envie.