Modèles de documents prêts à l'emploi

# <Verbe + objet, par exemple : Déployer un serveur dans le VLAN 21>

| Identifiant | Version | Date | Auteur | Relecteur | Statut |
|---|---|---|---|---|---|
| PROC-<DOMAINE>-<NNN> | <1.0> | <JJ/MM/AAAA> | <nom> | <nom> | <brouillon / validé / obsolète> |

## Objet et périmètre

<Ce que fait la procédure, en une ou deux phrases. Ce qu'elle ne fait pas.>

## Public et droits

<Qui peut l'exécuter ; avec quels comptes et quels accès.>

## Prérequis

- <Accès, outils, informations à réunir avant de commencer.>
- <État de départ à vérifier, avec la commande de vérification.>

## Impact et durée

<Coupure de service : oui ou non, combien de temps, fenêtre autorisée, utilisateurs à prévenir.>
<Durée estimée.>

## Point de retour

<Sauvegarde, instantané ou copie de la configuration à faire avant d'agir, et où le ranger.>

## Étapes

1. <Endroit, puis action.>

   ```bash
   <commande exacte>
   ```

   Résultat attendu : <ce que le lecteur doit voir>.

2. <Étape suivante.>

## Vérification finale

<Le test qui prouve que tout fonctionne, et son résultat attendu.>

## Retour arrière

<Comment revenir à l'état initial si l'opération échoue.>

## Après l'opération

- [ ] Plan d'adressage / inventaire mis à jour
- [ ] Supervision et sauvegarde configurées
- [ ] Ticket complété et clos

## Historique

| Version | Date | Auteur | Changement |
|---|---|---|---|
| <1.0> | <JJ/MM/AAAA> | <nom> | Création |

**Ticket <n°> : <titre>. <Équipement et numéro d'inventaire>, <demandeur>, <service ou site>.**

**Contexte.** <Symptôme, depuis quand, ce que l'utilisateur ne peut plus faire.>

**Diagnostic.** <Ce que tu as constaté et testé, dans l'ordre ; la cause, et comment tu l'as établie.>

**Actions.** <Ce que tu as fait, avec quel outil, quelle commande ; heure des actions importantes.>

**Résultat.** <Résolu ou non résolu ; le test qui le prouve.>

**Suite.** <Ce qui reste à faire, par qui, quand ; article de base de connaissances créé ?>

**Temps passé.** <durée> (<technicien>)

# <La question, comme l'utilisateur la pose : Que faire si l'imprimante affiche « Bourrage papier » ?>

**Visibilité :** <FAQ publique / interne au support>. **Mise à jour :** <JJ/MM/AAAA>. **Ticket d'origine :** <n°>.

## Symptôme

<Ce que voit l'utilisateur, avec le message exact entre guillemets.>

## Cause

<En une ou deux phrases, dans le vocabulaire du lecteur.>

## Solution

1. <Action, avec le libellé exact de l'interface.>
2. <Action.>

**C'est réglé quand :** <ce que l'utilisateur constate quand tout fonctionne>.

## Si ça ne suffit pas

<Ouvrez un ticket, comment>, en indiquant <le numéro du poste, le message exact, ce que vous avez déjà essayé>.

# Rapport de test : <service ou évolution testé>

**Version testée :** <version ou commit>. **Environnement :** <recette, laboratoire>.
**Date :** <JJ/MM/AAAA>. **Testé par :** <nom>.

| N° | Exigence testée | Test (action, poste, compte) | Résultat attendu | Résultat obtenu | Statut |
|---|---|---|---|---|---|
| T1 | <exigence> | <action précise> | <attendu> | <obtenu> | <Conforme / Non conforme> |
| T2 | | | | | |

**Tests automatisés :** `<commande>` : <nombre> tests, <nombre> réussis.

## Conclusion

<Nombre de tests conformes sur le total. Pour chaque non-conformité : cause, correction prévue, ticket.
Décision : mise à disposition acceptée, acceptée avec réserves ou reportée.>

# Rapport d'incident : <service touché>, <date>

**Rédigé par :** <nom>. **Date :** <JJ/MM/AAAA>. **Statut :** <en cours / clos>.

## Résumé

<Trois lignes : quoi, quand, combien de temps, quel impact, statut actuel.>

## Chronologie

| Heure | Fait |
|---|---|
| <hh:mm> | <début de l'incident> |
| <hh:mm> | <détection : comment> |
| <hh:mm> | <action> |
| <hh:mm> | <service rétabli, vérifié comment> |

## Impact

<Qui a été touché, combien de personnes, combien de temps, quelles données.>

## Cause

- **Cause directe :** <ce qui a provoqué la panne>.
- **Cause racine :** <pourquoi c'était possible : processus, contrôle, supervision manquants>.

## Correction

<Ce qui a rétabli le service.>

## Actions préventives

| Action | Responsable | Échéance |
|---|---|---|
| <action> | <nom> | <JJ/MM/AAAA> |

# Note de choix : <objet du choix>

**Version :** <1.0>. **Date :** <JJ/MM/AAAA>. **Rédigée par :** <nom>, pour <décideur>.

## Résumé

<La recommandation et sa raison principale, en deux lignes.>

## Besoin

<Le problème à résoudre, et pour qui.>
<Les contraintes : budget, délai, compétences de l'équipe, existant à réutiliser.>

## Critères et solutions comparées

Critères et coefficients fixés avec <décideur> le <JJ/MM/AAAA>, avant l'étude. Notes sur 5.

| Critère | Coef. | <Solution A> | <Solution B> |
|---|---|---|---|
| <Compatibilité avec l'existant> | <3> | <note : justification> | <note : justification> |
| <Coût total : licence, installation, formation, maintenance> | <2> | | |
| <Sécurité> | <2> | | |
| <Impact environnemental et éthique> | <1> | | |
| **Total pondéré** (sur <maximum>) | | **<total>** | **<total>** |

Sources : <documentation officielle, version, date de consultation>.

## Recommandation

<La solution retenue et ses raisons, en une phrase.>

## Risques et suites

- <Point faible de la solution retenue> : <comment on le maîtrise>.
- <Prochaine étape> : <qui, quand>.

# <Verbe + tâche, du point de vue de l'utilisateur : Signaler un problème sur votre poste>

<À quoi sert cette page, en une phrase. Durée : <2> minutes.>

**Avant de commencer :** <ce dont l'utilisateur a besoin, par exemple le numéro collé sur son poste>.

1. <Ouvrez ... > Vous voyez <...>.
2. <Cliquez sur **libellé exact**.>

   ![<texte alternatif qui décrit la capture>](img/<capture>.png)

3. <...>

**C'est fait quand :** <ce que l'utilisateur voit quand tout s'est bien passé>.

## Si ça ne marche pas

| Vous voyez | Que faire |
|---|---|
| « <message d'erreur exact> » | <action> |
| <autre situation> | <action, ou qui contacter et comment> |

*Page mise à jour le <JJ/MM/AAAA> pour la version <x.y> de <l'application>.*

# Fiche réflexe : <symptôme, par exemple : le pare-feu ne répond plus>

**Gravité :** <critique / majeure / mineure>. **Mise à jour :** <JJ/MM/AAAA>.

## Symptômes

- <Ce que voient les utilisateurs ou la supervision.>

## Premiers gestes

1. <Vérification la plus rapide et la plus probable, avec la commande.>
2. <Vérification suivante.>
3. <Action corrective connue, avec sa commande.>

## Escalader si

<Condition (par exemple : pas de retour à la normale après 15 minutes) ;
qui appeler (nom, numéro) ; quelles informations lui donner.>

## Après l'incident

<Compte rendu dans le ticket ; rapport d'incident si l'impact a été important.>

# Fiche serveur : <nom>

**Version :** <1.0> du <JJ/MM/AAAA>. **Propriétaire :** <nom>. **Statut :** <en production / en recette / retiré>.

| Rubrique | Valeur |
|---|---|
| Rôle | <à quoi il sert, pour qui> |
| Hébergement | <hôte, numéro de VM, ressources> |
| Système | <système et version> |
| Réseau | <VLAN, adresse, passerelle, nom DNS> |
| Services | <logiciels, versions, ports> |
| Dépendances | <ce dont il a besoin pour fonctionner> |
| Flux autorisés | <depuis où, vers quoi ; lien vers la matrice des flux> |
| Sauvegarde | <quoi, quand, où ; date du dernier test de restauration> |
| Supervision | <outil, modèle, alertes> |
| Accès d'administration | <comment se connecter ; entrée du gestionnaire de mots de passe, jamais le mot de passe> |
| Procédures liées | <identifiants et liens> |
| Historique | <JJ/MM/AAAA : événement> |

# Documentation technique : <évolution réalisée>

**Version :** <1.0>. **Date :** <JJ/MM/AAAA>. **Auteur :** <nom>.

## Objet

<Le besoin auquel répond l'évolution, en une ou deux phrases.>

## Ce qui a changé

- <Fichier, table, route, paramètre ou configuration modifié : avant, après.>
- <Copie de l'existant faite avant la modification : où.>

## Comment vérifier

<Les tests (renvoi au rapport de test) et un exemple de résultat.>

## Retour arrière

<Les étapes pour revenir à l'état précédent.>

## Documents mis à jour

- [ ] Schéma / plan d'adressage (SISR)
- [ ] Documentation de l'API, CHANGELOG (SLAM)
- [ ] Guide utilisateur, si l'utilisateur voit une différence

# <Nom du projet>

<Ce que fait le projet, pour qui, en deux phrases.>

Version actuelle : voir [CHANGELOG.md](CHANGELOG.md).

## Fonctionnalités

- <Ce que le projet sait faire aujourd'hui.>

## Prérequis

- <Logiciel et version>
- <Base de données et version>

## Installation

```bash
git clone <adresse du dépôt>
cd <dossier>
<commande d'installation des dépendances>
cp .env.example .env
```

## Configuration

| Variable | Rôle | Exemple |
|---|---|---|
| `<NOM>` | <rôle> | <valeur fictive> |

## Lancer et tester

```bash
<commande de lancement>
<commande des tests>
```

## Comptes de démonstration

| Rôle | Identifiant | Mot de passe |
|---|---|---|
| <rôle> | <compte de test> | <mot de passe de test, valable uniquement sur l'environnement de démonstration> |

## Documentation

- [Documentation de l'API](docs/api/openapi.yaml)
- [Guide utilisateur](docs/guide-utilisateur.md)

## Licence et contact

<Licence. Auteur, contact.>

# Changelog

Les changements notables de <projet> sont listés dans ce fichier.
Format : Keep a Changelog 2.0.0. Numérotation : versionnage sémantique 2.0.0.

## [Non publié]

### Ajouté

- <Nouvelle fonctionnalité, du point de vue de l'utilisateur.>

## [<X.Y.Z>] - <AAAA-MM-JJ>

### Ajouté
### Modifié
### Obsolète
### Supprimé
### Corrigé
### Sécurité

[Non publié]: <lien de comparaison entre le dernier tag et HEAD>
[<X.Y.Z>]: <lien de comparaison avec la version précédente>

# Nouveautés de <application> <X.Y> (<JJ/MM/AAAA>)

**Nouveau :** <ce que l'utilisateur peut faire de plus, dans son vocabulaire, et où le trouver>.

**Corrigé :** <le problème qu'il rencontrait, et qui ne se produit plus>.

**À savoir :** <ce qui change dans ses habitudes, ce qu'il doit faire, la date>.

Une question ? <Comment contacter le support.>