4 technologies open source pour faciliter l’écriture
Français
J’enseigne des cours universitaires en parallèle, et l’un des cours du dernier semestre était Rédaction avec la technologie numérique, où les étudiants ont découvert différentes technologies et outils que les rédacteurs techniques utilisent dans l’industrie. Les sujets comprenaient HTML, CSS, XML, DITA, Markdown, GitHub et d’autres outils et technologies d’écriture.
Alors que je terminais le dernier semestre, ma classe et moi nous sommes penchés sur les technologies que nous avons aimé apprendre. Si vous débutez dans la rédaction technique, vous pourriez être intéressé par cette liste de technologies ouvertes qui facilitent la rédaction technique.
Contents
HTML
Chaque site Web est construit sur HTML, le langage de balisage hypertexte. Alors que les rédacteurs techniques professionnels peuvent utiliser des outils Web tels que Drupal ou TYPO3 pour créer des pages Web, il est toujours agréable de savoir comment les choses fonctionnent dans les coulisses en apprenant le HTML. Bien que cela ne se produise pas très fréquemment, un outil Web génère parfois un code HTML incorrect. Les rédacteurs techniques doivent savoir comment réparer les pages Web en modifiant le code HTML sans le casser davantage.
Le code HTML est entièrement basé sur du texte, avec des balises entre crochets. Les éléments sont soit en bloc, soit en ligne, tels que
pour définir un paragraphe en bloc ou pour mettre l’accent (généralement en italique) sur un mot ou une phrase.
Les rédacteurs techniques peuvent se concentrer sur l’écriture de contenu en HTML et la définition de styles dans un fichier CSS ou une feuille de style distinct pour définir la façon dont le contenu apparaît à l’écran. Cette séparation du contenu et de l’apparence est un excellent moyen de se concentrer sur l’écriture.
Réduction
Une autre façon d’écrire de la documentation est avec Markdown. Markdown vise à rationaliser l’écriture technique en supprimant autant que possible la syntaxe de balisage, en la remplaçant par des conventions standard que vous pourriez utiliser lors de l’écriture dans un fichier texte brut.
Par exemple, pour commencer un nouveau paragraphe dans Markdown, ajoutez une ligne vide dans votre fichier texte. Le paragraphe suivant commence par le bloc de texte suivant. Ajoutez des en-têtes en traçant une ligne en dessous, comme celle-ci pour créer un en-tête de niveau supérieur :
Title of my document
====================
Et ceci pour créer un sous-titre dans un document :
How to use the software
-----------------------
Markdown est souvent utilisé lors de l’écriture de fichiers Lisez-moi ou d’autres documents de projet sur GitHub ou GitLab. Cela fait de Markdown un choix populaire pour les développeurs open source ainsi que pour les rédacteurs techniques.
DITA
Darwin Information Typing Architecture (DITA) est essentiellement un fichier XML avec une structure de fichier particulière. Lors de la création d’une documentation de projet avec DITA, les rédacteurs techniques se concentrent sur la manière de réutiliser et de remixer le contenu pour créer de nouveaux types de fichiers de sortie.
Par exemple, trois formats de fichiers DITA courants sont le concept DITA qui décrit un chose ou un processus, DITA Task qui répertorie les étapes d’exécution d’un processus et DITA Reference qui fournit uniquement les faits concernant un sujet, tels que des avertissements ou des notes importantes.
DITA est un outil puissant pour les rédacteurs techniques car vous pouvez assembler un document en créant un fichier XML distinct appelé DITAMap qui compile plusieurs fichiers DITA sur un sujet. Cela permet aux rédacteurs techniques de réutiliser le contenu sans copier et coller entre des documents distincts. DITA Open Toolkit et d’autres outils DITA fournissent des transformations qui transforment la source DITA en différents types de sortie, notamment des documents PDF, des sites Web HTML et des livres EPUB.
LibreOffice
Si vous préférez utiliser un traitement de texte traditionnel pour écrire de la documentation, LibreOffice Writer fournit une option open source exceptionnelle. Les rédacteurs peuvent exploiter différents styles disponibles dans LibreOffice pour définir des titres de chapitre, des en-têtes de section, des paragraphes et des exemples de code dans un document. LibreOffice prend également en charge style de caractère qui aident à mettre en évidence ou à mettre en évidence les mots-clés du code source et d’autres textes en ligne.
Les styles de page de LibreOffice permettent une grande flexibilité dans la création de documentation imprimée. Par exemple, les styles de page incluent les pages gauche et droite, généralement utilisées dans les documents plus longs pour garantir que les nouveaux chapitres ou sections principales commencent toujours sur la page de droite d’un livre imprimé. Les en-têtes et les pieds de page peuvent être définis indépendamment sur les pages de gauche et de droite, offrant une plus grande flexibilité dans la rédaction technique.
LibreOffice est un traitement de texte de bureau plus traditionnel avec une interface facile à apprendre. La plupart des fonctionnalités sont disponibles directement sur la barre d’outils, avec des fonctionnalités supplémentaires dans les menus. Ou utilisez le volet Styles contextuel pour sélectionner rapidement le style de paragraphe, de caractère ou de page que vous souhaitez utiliser.
Cet article a été co-écrit par : Teagan Nguyen, Joshua Hebeisen, Aurora Dolce, David Kjeldahl et Rose Lam.
