Guide de rédaction du centre d'aide

Ce guide définit les conventions de rédaction et les composants éditoriaux disponibles pour les articles du centre d’aide Cyanet. Il s’adresse aux contributeurs internes et externes qui rédigent ou mettent à jour des pages dans /content/aide/.

Pour les conventions associées, voir aussi le guide de rédaction sur le dépôt.

Suggérer une modification#

Toute page du centre d’aide peut être corrigée ou améliorée. Les contributions externes sont les bienvenues : forker le dépôt et ouvrir une pull request.

Directives de rédaction générales#

Langue#

Le centre d’aide est rédigé en français. Utilisez la grammaire, l’orthographe et la typographie françaises standard. Les termes techniques anglais (WiFi, Ethernet, SIP, IP) restent en anglais lorsqu’ils sont plus clairs.

Ton#

Le ton est neutre et direct. Évitez la voix passive, le futur, les contractions familières et les formules de politesse superflues.

Cohérence#

La cohérence est essentielle pour la qualité du centre d’aide :

• Utilisez les mêmes termes pour les mêmes concepts (box, WiFi, fibre, Trunk SIP)
• Appliquez la même structure à toutes les pages d’un même type
• Respectez les règles de grammaire et de typographie de manière uniforme

Types de pages, formats et structure#

Types de pages#

Chaque article du centre d’aide appartient à l’une des catégories suivantes :

Format de page#

Tous les articles sont des fichiers Markdown (.md) avec frontmatter YAML. Les images sont au format .jpg ou .webp.

Structure de page#

Chaque article suit cette structure :

Contenu de page#

Titres#

• Un seul H1 par titre (le titre de la page, défini dans le frontmatter)
• Utilisez les H2 (##) pour diviser la page en sections, les H3 (###) pour les sous-sections
• Tous les titres sont en sentence case (majuscule au premier mot et aux noms propres uniquement)
• Aucun titre orphelin : si vous commencez par H2, descendez en séquence

Étapes numérotées#

Quand vous expliquez une procédure, utilisez des étapes numérotées :

1. Chaque étape représente une action unique

2. Chaque étape commence par un verbe à l’impératif

3. Si vous voulez expliquer l’effet de l’action, faites-le en fin d’étape

4. Ouvrez votre navigateur et saisissez 192.168.1.1.

5. Saisissez le mot de passe admin, puis appuyez sur Entrée .

6. Cliquez sur WiFi > Sécurité. La page des paramètres sans fil s’affiche.

7. Modifiez le champ Clé de sécurité, puis cliquez sur Appliquer.

Blocs de code#

Les blocs de code indiquent toujours leur langage. La coloration syntaxique et le bouton de copie sont automatiques :

# Tester la connectivité vers la box
ping -c 4 192.168.1.1

[trunk]
type=registration
server_uri=sip:sip.cyanet.fr
client_uri=sip:votre_identifiant@sip.cyanet.fr

services:
  pbx:
    image: asterisk:latest
    ports:
      - "5060:5060/udp"

Code inline#

Utilisez le code inline pour référencer des informations dans le texte : variables d’environnement, valeurs de remplacement, commandes courtes.

Redémarrez le service avec systemctl restart asterisk.

Liens#

Utilisez la syntaxe Markdown native pour les liens :

• Liens internes : relatifs avec slashes — [guide WiFi](/aide/depannage/resoudre-problemes-wifi/)
• Liens externes : URL complète, sources stables et neutres privilégiées
• Texte de lien : descriptif, jamais « cliquez ici » ou « ici »

Encadrés de message#

Trois types d’encadrés sont disponibles, du moins au plus critique :

Onglets#

Utilisez les onglets pour présenter des instructions qui varient selon l’équipement, le système d’exploitation ou une condition :

• Box Cyanet
• Routeur perso

Marques inline#

Les marques inline distinguent visuellement les références techniques du texte courant :

• Touche clavier : appuyez sur Ctrl + C
• Chemin de fichier : éditez /etc/asterisk/pjsip.conf
• Commande courte : sip show peers

Grammaire, syntaxe et typographie#

Pronoms#

Pour s’adresser à l’utilisateur, utilisez « vous ». Pour désigner Cyanet, utilisez « Cyanet » (pas « nous » ou « notre »).

Possessifs#

Évitez les possessifs avec les noms de produits ou de fonctionnalités. Exprimez la possession par reformulation.

Majuscules#

• Majuscule aux noms propres et produits : Cyanet, La Réunion, Trunk SIP, IPBX
• Pas de majuscule aux noms de fonctionnalités : wifi, fibre, téléphonie
• Titres en sentence case

Gras#

Utilisez le gras pour les éléments d’interface que l’utilisateur doit cliquer, sélectionner ou trouver.

✅ Cliquez sur Appliquer pour enregistrer. ✅ La page des paramètres s’affiche.

N’utilisez pas le gras pour l’emphase dans le texte courant.

Prépositions#

Utilisez « cliquez sur », pas « cliquez » tout court.

✅ Cliquez sur Appliquer pour enregistrer. ❌ Cliquez Appliquer pour enregistrer.

Virgules#

Utilisez la virgule de série (Oxford comma) française.

Nombres et chiffres#

Nombres#

• Utilisez les chiffres arabes (ex. « un maximum de 9 box »)
• Utilisez les virgules pour séparer les milliers (ex. 5 000, 250 000)
• Utilisez les points pour les décimales (ex. 0,5)

Dates#

Pour les dates, utilisez le format JJ mois AAAA (ex. « 12 janvier 2026 »). Évitez les ordinaux (ex. « 12e janvier »).

Heures#

Pour les heures, utilisez le format 24h (ex. « 14h30 »).

Bits et octets#

• Ajoutez une espace entre l’abréviation et le nombre (ex. 100 Mo, 1 Gbit/s)
• Utilisez les abréviations suivantes :

Vocabulaire#

Termes techniques#

Noms de produits#

Utilisez la terminologie exacte des produits Cyanet. Consultez la page des offres pour les dénominations officielles.

Métadonnées (frontmatter)#

Chaque article commence par un frontmatter YAML :

---
draft: false            # retrait uniquement après relecture
title: "Question ou action"
description: "1-2 phrases pour le SEO et la recherche"
date: 2026-09-26
image: /img/articles/default.jpg
weight: 1                # ordre dans la catégorie
author: "Équipe Cyanet"
outdated: true           # optionnel : bannière « Article obsolète »
outdated_message: "..."  # optionnel : remplace le message par défaut
---

• title : titre de la page, utilisé par les moteurs de recherche et comme titre principal (H1)
• description : description SEO, 120-160 caractères, affichée dans les résultats de recherche
• date : date de création au format AAAA-MM-JJ
• image : image de partage pour les réseaux sociaux
• weight : ordre d’affichage dans la catégorie (1 = premier)
• outdated : si true, affiche une bannière « Article obsolète » en tête de page

Introduction#

L’introduction doit être composée de quelques phrases ou paragraphes courts qui expliquent le but de l’article et pourquoi il peut intéresser l’utilisateur. Mentionnez brièvement les produits ou fonctionnalités clés. Incluez des liens vers d’autres pages pertinentes si nécessaire.

Prérequis#

Pour les how-to, l’encadré prérequis s’affiche avant la première étape :

Voir aussi#

Pour un exemple d’article de dépannage, voir résoudre les problèmes WiFi. Pour contacter le support, voir la page contact.