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.
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.
Lorsqu'on veut rédiger un document, le premier réflexe est souvent d'utiliser un traitement de texte. Pourtant, par l'exposition d'une pléthore de fonctionnalités de présentation et de mise en page, ces outils sont contre-productifs en détournant l'utilisateur de son travail de rédaction. LATEX est une autre solution permettant de se focaliser sur l'écriture et de concevoir des documents complexes, mais son utilisation est plus compliquée. Enfin, il existe une alternative simple et efficace pour les auteurs. Il s'agit de Markdown.
Le Markdown est devenu incontournable. Il est facilement manipulable, stockable, versionnable et partageable. Un moteur de rendu automatique peut transformer toute la substantifique moelle de l’auteur en un ouvrage broché digne de la Bible de Gutenberg. Alors, pourquoi ne pas appliquer ce modèle à l’écriture de nouveaux articles pour notre cher magazine ?
Les langages de balisage léger tels que Markdown permettent de rédiger vos documents sans avoir à se soucier du format de fichier souhaité et sans devoir utiliser un logiciel dédié. Mais une fois le document terminé, comment diffuser votre travail à vos lecteurs ? C’est là justement qu’intervient Pandoc !
Éditeur de presse spécialisé dans l’open source, la programmation, la cybersécurité, l’électronique et l’embarqué,
les Éditions Diamond sont nées en 1995 avec l’objectif de développer une offre rédactionnelle technique de qualité basée
sur les retours d’expériences de professionnels et de passionnés du milieu au travers de nos publications :
• GNU/Linux Magazine
• MISC
• Linux Pratique
• Hackable
En 2013 nous lançons la plateforme de documentation numérique Connect qui permet aux lecteurs d’explorer plus de
10 ans de ressources techniques issues de ses magazines phares.
Continuellement mise à jour au fil des publications et enrichie avec du contenu exclusif, elle constitue un outil de veille
efficace pour les professionnels qui souhaitent s’informer et se former aux dernières technologies. Connect offre
aujourd’hui une réponse unique aux besoins informationnels :
• des développeurs avec GNU/Linux Magazine
• des administrateurs système et réseau avec Linux Pratique
• des experts en sécurité informatique avec MISC
• des professionnels et passionnés d’électronique numérique et d’embarqué avec Hackable.