Comment rédiger un article 🤔
Introduction (en-tête moyen)
Salut à toi technicien support !
Cet article t'es directement destiné pour te guider sur comment rédiger un bon article wiki, simple, basique !
Prérequis
- Un cerveau 🧠
- Un peu de créativité
- Un résultat dont tu es sûr !
Déroulé (ou comment faire) ?
Tout d'abord, si tu veux expliquer à un client comment se connecter à un serveur, tu le fait de la façon suivante :
Connectez vous en SSSHSSH à votre serveur grâce à Putty (partpar exemple) :
ssh root@123.456.789.69 -p44712
Tu vois, vu qu'on indique une commande à saisir, on la mets dans un bloc de code, ça fait plus joli !
Tu peux même illustrer cela avec une image :
Comment j'ai fait ? Et bien avec un simple copier/coller depuis l'outil capture d'écran de windows !
Mais ce n'est pas tout, on peux faire bien d'autres choses comme par exemple, fournir un script complet au client tel que :
$VMHostName = "ablesxi03.ikoula.biz"
$HostView = Get-VMHost -Name $VMHostName | Get-View
$HealthStatusSystem = Get-View $HostView.ConfigManager.HealthStatusSystem
$SystemHealthInfo = $HealthStatusSystem.Runtime.SystemHealthInfo
ForEach ($Sensor in $SystemHealthInfo.NumericSensorInfo) {
$Report = "" | Select-Object VMHost,Sensor,Status
$Report.VMHost = $VMHostName
$Report.Sensor = $Sensor.Name
$Report.Status = $Sensor.HealthState.Key
$Report
}
Bon, c'est du powershell, mais ça fait l'affaire !
Partie 2 - Le retour 👽
Oui on peux aussi mettre des émojis, vous pouvez les copier coller depuis un site tel que https://emojikeyboard.top/fr/ , ça fait plutôt moderne ! 😁
On peux souligner certains points plus ou moins importants, les mettre en gras quand c'est super important, ou en gras coloré et souligné lorsque l'avenir du monde en dépend !
Parfois on peut être amené à donner plusieurs informations à un client, comme par exemple, les informations à saisir dans un client de messagerie pour ajouter sa boîte mail.
On pourrais les donner tel que :
Nom d'utilisateur : votre adresse email
Mot de passe : Le mot de passe de votre adresse email
Serveur IMAP : zimbramail.ex10.biz
Port : 143
Type de sécurité : STARTTLS
Alors qu'avec un tableau, ce serait plus joli :
| Nom d'utilisateur | mschombert@ikoula.com |
| Mot de passe | Ikoulalalalaley1234!* |
| Serveur IMAP | zimbramail.ex10.biz |
| Port | 143 |
| Type de sécurité | STARTTLS |
Conclusion
Cet article reste un exemple, vous êtes libre de l'adapter à vos besoins mais veillez bien à garder une cohérence dans la présentation !
