Charte documentaire IPEOS

Comment écrire et placer une page dans cette documentation. Source versionnée dans le dépôt doc-ipeos-skill (ai_doc/reference/charte-doc-ipeos.md) ; cette copie est publiée par le skill.

• Charte documentaire IPEOS
• Gabarit — procédure
• Gabarit — mémo
• Gabarit — référence
• Gabarit — guide
• Gabarit — décision

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)

Tag	Valeurs	Obligatoire
type	procédure · référence · mémo · guide · décision	oui
produit	libre, minuscules, sans espace (proxmox, glpi, spip)	oui si un produit est concerné
statut	à-jour · à-vérifier · obsolète	oui (à-jour à la création)
client	identifiant client, minuscules	seulement pour une doc spécifique

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

<Pourquoi cette procédure existe, sur quel périmètre elle s'applique, à qui elle s'adresse.>

Prérequis

• <Accès, droits, versions, fenêtre d'intervention.>

Procédure

1. <Étape.>

   <une commande par bloc>
   

2. <Étape.>

Vérification

<Comment savoir que c'est fait : commande, sortie attendue, écran.>

Retour arrière

<Comment revenir à l'état précédent si l'étape échoue.>

Références

• <Lien vers la page BookStack ou la documentation éditeur.>

Gabarit — mémo

Quoi

<Le problème traité, en deux lignes.>

Commandes

<commande>

Pièges

• <Ce qui surprend, ce qui casse.>

Gabarit — référence

Vue d'ensemble

<De quoi parle cette référence, et ce qu'elle ne couvre pas.>

Détail

Élément	Valeur	Commentaire
<élément>

Sources

• <Origine de l'information, avec sa date.>

Gabarit — guide

Objectif

<Ce que le lecteur saura faire à la fin.>

Étapes

1. <Étape, avec le pourquoi autant que le comment.>

Aller plus loin

Gabarit — décision

Contexte

<La situation qui a imposé un choix, à la date du choix.>

Décision

<Ce qui a été décidé, en une phrase.>

Alternatives écartées

• — écartée parce que .

Conséquences

<Ce que cela impose désormais, et ce que cela ferme.>