Style d'écriture

La documentation est une partie essentielle de DraftBot, elle permet à chaque utilisateur d'avoir une bonne expérience et utilisation du bot. Il est important qu'il puisse trouver des réponses à ses questions de manière simple et en autonomie.

Voici donc quelques conseils pour améliorer votre qualité d'écriture :

1. Clarté et Concision : Utilisez un vocabulaire clair et précis, en essayant au maximum de correspondre aux expressions de DraftBot. Évitez le jargon inutile et les phrases longues. Votre objectif est de rendre l'information facilement compréhensible pour le lecteur.
2. Restez bienveillants : Evitez le plus possible les expressions subjectives comme "simplement", "juste", "logiquement". Gardez en tête que nous avons tous une expérience et un passé différent. Ces mots n'apportent aucune information utile et peuvent parfois même être réducteurs et blessants, notamment pour les personnes découvrant Discord ou débutant leur utilisation avec DraftBot.
3. Utilisez le discours informatif : L'intérêt de la documentation est clairement de transmettre des informations et connaissances concernant l'utilisation du bot. Afin de correspondre à ce discours, essayez autant que possible de rester neutre et objectif, sans chercher à convaincre, divertir ou imposer des choix ou actions.
4. Cohérence : Gardez une cohérence dans le style, le ton, et la terminologie à travers toute la documentation. Cela aide à maintenir une expérience de lecture fluide et professionnelle. Dans ce but, employez le vouvoiement uniquement et essayez au maximum d'utiliser la forme déclarative à la voix active, au présent dans la majorité des cas. Des exceptions et écarts peuvent évidemment être faits selon la situation, pour revenir sur une explication passée ou aborder une possibilité à venir.

Outils de structuration

Organisez votre contenu de manière logique. Utilisez des titres, des sous-titres, des onglets et des captures d'écran de manière à ce qu'il soit facile à suivre. Retrouvez ci-dessous toutes les structurations possible.

Titres

# H1
## H2
### H3
#### H4

Markdown de base

PrévisualisationMarkdown

Gras

Italique

Gras italique

Gras italique

Barré

Code

www.lien-automatique.com

lien vers une URL

lien vers une page du panel

lien vers un nouvel onglet

"Citation"

Ctrl A + C

**Gras**

*Italique*

**_Gras italique_**

***Gras italique***

~~Barré~~

`Code`

[lien vers une URL](https://www.youtube.com/watch?v=dQw4w9WgXcQ)

[lien vers un nouvel onglet](https://www.youtube.com/watch?v=dQw4w9WgXcQ){target=_blank}

[lien vers une page du panel](/dashboard/first/embeds)

![image](https://i.imgur.com/hgmR4m0.jpeg)

> "Citation"

:shortcut{value="meta"} :shortcut{value="A"} + :shortcut{value="C"}

Emojis & mentions

Annotations

Une première annotation[^1]

Une deuxième annotation[^2]

[^1]: Information.

[^2]: Autre chose.

Puces & listes

- Puce 1
- Puce 2
- Puce 3
  - Puce 3.1
    - Puce 3.1.1

1. Num 1
2. Num 2
3. Num 3

- [ ] case 1
- [x] case 2

Hints d'informations

::hint{ type="success" }
Petite information sympatique positive
::

::hint{ type="info" }
Petite information sympatique informative
::

::hint{ type="warning" }
Petite information moyennement sympatique d'avertissement
::

::hint{ type="danger" }
Petite information pas sympatique
::

Tableau

| Chaudron  | Test      |
|-----------|-----------|
| Machin    | Boulanger |
| Poubelle  | Rototo    |
| Zoro      | Burrito   |

Déroulant

::collapse{ label="Texte" }
  Long

  texte

  sur

  plusieurs

  lignes
::

Tabs

::tabs
  ::tab{ label="Tab 1" }
    Information 1
  ::

  ::tab{ label="Tab 2" }
    Information 2
  ::

  ::tab{ label="Tab 3" }
    Information 3
  ::
::