# Charte documentaire IPEOS

# Charte documentaire IPEOS

# Charte documentaire IPEOS (BookStack)

> Référence de cohérence pour toute page écrite ou modifiée par le skill `doc-ipeos`, sur doc.ipeos.com comme sur toute autre instance configurée. Née du cadrage WI-20260922-MAIN-001 (round 2, Q5) ; à publier dans BookStack (étagère « Manifeste des développeurs ») par le skill lui-même, puis maintenue là. Cette copie reste la source jusqu'à la publication.

## 1. Placement

- Chercher d'abord (`search`, `grep`, `propose-location`) : une page existante sur le même sujet se **met à jour**, elle ne se duplique pas.
- Une page va dans un **livre existant** quand le produit ou le thème existe déjà ; un chapitre quand le livre dépasse une dizaine de pages. Un nouveau livre est l'exception : il porte une description.
- Étagères : Administration Système · Gestion de parc · Développement web · Web Hosting · R&D · Manifeste des développeurs. Pas de nouvelle étagère sans décision humaine.

## 2. Titres

- Français, nominal et court : « Sauvegarde PBS des VM Proxmox », pas « Comment sauvegarder… ».
- Pas de préfixe de produit si le livre le porte déjà (dans le livre Proxmox : « Sauvegarde PBS »).
- Un titre ne répète pas le titre d'une page voisine du même livre.

## 3. Tags (obligatoires à la création)

<table id="bkmrk-tag-valeurs-obligato"><thead><tr><th>Tag</th><th>Valeurs</th><th>Obligatoire</th></tr></thead><tbody><tr><td>`type`</td><td>`procédure` · `référence` · `mémo` · `guide` · `décision`</td><td>oui</td></tr><tr><td>`produit`</td><td>libre, minuscules, sans espace (`proxmox`, `glpi`, `spip`)</td><td>oui si un produit est concerné</td></tr><tr><td>`statut`</td><td>`à-jour` · `à-vérifier` · `obsolète`</td><td>oui (`à-jour` à la création)</td></tr><tr><td>`client`</td><td>identifiant client, minuscules</td><td>seulement pour une doc spécifique</td></tr></tbody></table>

## 4. Gabarits

**procédure** — Contexte · Prérequis · Procédure (étapes numérotées, une commande par bloc) · Vérification · Retour arrière · Références.

**mémo** — Quoi · Commandes · Pièges.

**référence** — Vue d'ensemble · Détail (tableaux) · Sources.

**guide** — Objectif · Étapes · Aller plus loin.

**décision** — Contexte · Décision · Alternatives écartées · Conséquences.

## 5. Corps

- Markdown uniquement, jamais de HTML brut (les pages WYSIWYG existantes sont migrées).
- Une commande = un bloc ````bash`. Pas de secret réel : `<mot-de-passe>` en placeholder.
- Lier les pages BookStack existantes par URL complète plutôt que recopier leur contenu.
- Dater les informations périssables (versions, URL de téléchargement) dans le texte.

## 6. Mise à jour

- Modifier une page conserve son titre et ses tags sauf demande ; `statut` passe à `à-jour`.
- Une page dépassée n'est pas supprimée : `statut=obsolète` et un lien vers la page qui la remplace.

# Gabarit — procédure

## Contexte

&lt;Pourquoi cette procédure existe, sur quel périmètre elle s'applique, à qui elle s'adresse.&gt;

## Prérequis

- &lt;Accès, droits, versions, fenêtre d'intervention.&gt;

## Procédure

1. &lt;Étape.&gt;
    
    ```bash
    <une commande par bloc>
    
    ```
2. &lt;Étape.&gt;

## Vérification

&lt;Comment savoir que c'est fait : commande, sortie attendue, écran.&gt;

## Retour arrière

&lt;Comment revenir à l'état précédent si l'étape échoue.&gt;

## Références

- &lt;Lien vers la page BookStack ou la documentation éditeur.&gt;

# Gabarit — mémo

## Quoi

&lt;Le problème traité, en deux lignes.&gt;

## Commandes

```bash
<commande>

```

## Pièges

- &lt;Ce qui surprend, ce qui casse.&gt;

# Gabarit — référence

## Vue d'ensemble

&lt;De quoi parle cette référence, et ce qu'elle ne couvre pas.&gt;

## Détail

<table id="bkmrk-%C3%89l%C3%A9ment-valeur-comme"><thead><tr><th>Élément</th><th>Valeur</th><th>Commentaire</th></tr></thead><tbody><tr><td>&lt;élément&gt;</td><td><valeur></valeur></td><td><commentaire></commentaire></td></tr></tbody></table>

## Sources

- &lt;Origine de l'information, avec sa date.&gt;

# Gabarit — guide

## Objectif

&lt;Ce que le lecteur saura faire à la fin.&gt;

## Étapes

1. &lt;Étape, avec le pourquoi autant que le comment.&gt;

## Aller plus loin

- <page approfondir.="" ou="" pour="" ressource=""></page>

# Gabarit — décision

## Contexte

&lt;La situation qui a imposé un choix, à la date du choix.&gt;

## Décision

&lt;Ce qui a été décidé, en une phrase.&gt;

## Alternatives écartées

- <option> — écartée parce que <raison>.</raison></option>

## Conséquences

&lt;Ce que cela impose désormais, et ce que cela ferme.&gt;