3. Diagramme de cas d’utilisation (Use Case)
Un diagramme de cas d’utilisation permet de présenter les interactions principales entre les utilisateurs et le système. Voici un exemple simple pour un système de documentation :
20 June 2025
8 à 12 minutes.
Développeurs, rédacteurs techniques, et toute personne souhaitant rédiger de la documentation technique ou des articles riches.
AsciiDoc est un langage de balisage léger, conçu pour rédiger des documents techniques structurés, des articles, des livres, ou encore des présentations. Il se distingue par sa lisibilité, sa richesse syntaxique et sa capacité à générer divers formats (HTML, PDF, DocBook, etc.). Dans cet article, nous allons explorer la syntaxe essentielle d’AsciiDoc et proposer des astuces pour une prise en main rapide.
AsciiDoc est un langage de description de documents, similaire à Markdown mais plus puissant. Il permet de structurer efficacement textes, titres, listes, tableaux, blocs de code, et bien plus encore. Sa polyvalence en fait un choix populaire pour la documentation de projets open source, la rédaction de livres et la publication web.
Syntaxe lisible et intuitive.
Support natif de structures complexes (tableaux, notes, admonitions, etc.).
Génération multi-formats (HTML, PDF, ePub, DocBook…).
Intégration facile avec des générateurs de sites statiques comme JBake ou Antora.
Personnalisation avancée avec les attributs et extensions.
Un diagramme de cas d’utilisation permet de présenter les interactions principales entre les utilisateurs et le système. Voici un exemple simple pour un système de documentation :
Le mind map (carte mentale) est idéal pour explorer les concepts liés à AsciiDoc et leurs relations :
Un diagramme de flow permet de décrire le processus de génération d’un document AsciiDoc :
Un fichier AsciiDoc commence généralement par un titre, des attributs optionnels, puis le contenu structuré. Voici un exemple minimal :
= Titre Principal
Auteur
2024-09-03
:toc:
:icons: font
Votre contenu commence ici...AsciiDoc supporte plusieurs niveaux de titres :
= Titre de niveau 1
== Titre de niveau 2
=== Titre de niveau 3
==== Titre de niveau 4*gras* _italique_ `monospace`* Élément 1
* Élément 2
. Premier
. Deuxième
. TroisièmeLien standard : https://asciidoc.org[AsciiDoc]
Image : image::images/logo.png[AsciiDoc Logo][source,python]def hello(): print("Bonjour AsciiDoc !")
|===
| Colonne 1 | Colonne 2
| Valeur A
| Valeur B
| Valeur C
| Valeur D
|===AsciiDoc propose des blocs d’information visuelle :
NOTE: Ceci est une note importante.
TIP: Conseil utile pour l’utilisateur.
WARNING: Attention à ce point.Les attributs personnalisés permettent de réutiliser des valeurs ou de configurer des comportements :
:project-name: AsciiDoc Explorer
Le projet s’appelle {project-name}.Documentation projet open source (README, guides techniques)
Rédaction de livres et ebooks
Génération automatique de sites web statiques (JBake, Antora)
Présentations techniques
Utilisez des titres cohérents et un sommaire automatique (:toc:).
Privilégiez les admonitions pour attirer l’attention sur des points clés.
Structurez vos fichiers pour faciliter la maintenance.
Profitez des blocs de code annotés pour illustrer des exemples.
AsciiDoc est un outil puissant et accessible pour rédiger toute documentation technique ou article structuré. Sa syntaxe riche, combinée à la génération multi-formats, en fait un allié de choix pour les développeurs et rédacteurs exigeants. Essayez AsciiDoc dans votre prochain projet et découvrez la différence !
Documentation officielle : https://asciidoc.org
Asciidoctor : https://asciidoctor.org
JBake et AsciiDoc : https://jbake.org/docs/2.6.4/#asciidoc_support
Partagez vos expériences et astuces en commentaire !