Page de référence

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 : Évitez 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.

Règles de rédaction

Introduction orienté utilisateur

Lors de la rédaction d'une page, toujours commencer par une présentation du système du point de vue de l'utilisateur.

Lorsqu'un gérant de serveur prend la décision de mettre en place un système, il voudra toujours se placer à la place de l'utilisateur cible, s'il est convaincu, il passera à la mise en place.

Fonctionnalités Premium

Lorsqu'on veut souhaite indiquer qu'une fonctionnalité est premium, ne pas l'indiquer dans le titre ou dans la description de la fonctionnalité. Préférer utiliser un hint info, plusieurs formulations comme celles-ci peuvent être adéquates :

Limite étendue par le premium

::hint{ type="info" }
  Vous pouvez lancer jusqu'à 3 giveaways en simultané. Les serveurs [premium](/premium) <:icon_premium_:1096140508625125417> n'ont pas de limite.
::

Fonctionnalité premium

::hint{ type="info" }
  Cette fonctionnalité est réservée aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>.
::

Captures d'écran

Elles sont essentielles pour illustrer et aérer la documentation. Afin d'être en harmonie avec le reste de la documentation :

1. Préférez faire des prises larges sans modification des captures.
   Les modifications nécessaires tel que le détourage, ou le cadrage des captures seront faites par un référent rédacteur une fois la rédaction et des corrections terminées.
2. Utilisez exclusivement le thème Discord appelé "Sombre".

Liens vers le panel

Permettez à l'utilisateur de se rendre sur la page concernée du panel à chaque changement de page :

• En haut de la section concernée
• Sur chaque section concernée (même si ça revient plusieurs fois sur la même page)

[⫸ Accéder au panel de **DraftBot**](/dashboard/first/nomDuModule)

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 possibles.

Titres

## 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`

www.lien-automatique.com

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

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

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

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

> "Citation"

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

Emojis & mentions

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
  ::
::

Carte

::card
---
title: Modules
icon: material-symbols:view-module-rounded
to: /docs/modules
target: _blank
color: '#00ff00'
---
Découvrez une page secrète dans un nouvel onglet
::