Conventions d’écriture dans ce livre

Je m’attache à toujours utiliser des expressions explicites dans ma rédaction.

Je pourrais écrire des mots simples isolés comme « page » et supposer que le lecteur comprend, en fonction du contexte, s’il s’agit d’une page mdBook c’est-à-dire d’une page composée avec mdBook ou s’il s’agit d’une simple page web.
Je pense qu’il est préférable d’être explicite pour que les choses soient plus claires et ne prêtent pas à erreur d’interprétation.

Je m’attache à utiliser toujours la même expression pour le même concept.

Je pourrais écrire à un endroit projet mdBook et plus loin « document » ou « guide » en parlant de ce même projet mdBook.
Je pense qu’il est préférable d’écrire ainsi pour une meilleure lisibilité du texte et pour la bonne interprétation et assimilation des concepts clefs.

J’écris les codes sources et les objets informatiques en tant que codes.

Cela inclut les noms de dossiers et les noms de fichiers : SUMMARY.md, book.toml ou encore nom-du-projet/src.

Cela inclut les caractères isolés qui sont utilisés dans le code en langage Markdown, par exemple ` ou *.

J’écris les mots anglais ou en langues étrangères en caractères italiques.

Je prends soin d’écrire les mots toujours dans le même format.

C’est le cas par exemple de Markdown et de mdBook.

Ces manières d’écrire sont des choix arbitraires.
J’aurais pu choisir d’écrire « MarkDown », j’ai choisi Markdown.
J’aurais pu écrire « mdbook » ou « MDBOOK », j’ai choisi mdBook qui est l’usage dans la communauté Rust.

Notons au passage que Markdown est un nom propre.
Je tiens à mettre des lettres majuscules aux premières lettres des noms propres, en accord avec la typographie française.

La règle peut être différente dans les conventions de nommage ou des conventions de codage :

• mdbook peut devoir être écrit ainsi dans un fichier de configuration par exemple ;
• de même, des noms propres peuvent être écrits tout en lettres minuscules dans des codes informatiques.

Je respecte ma convention de nommage des dossiers et des fichiers dans ce que j’écris.

Je respecte les règles de la typographie française.