Source : docs/README.md — ce document se lit aussi dans le dépôt, sans serveur.

Documentation de Darsy

Darsy est l'ERP de Monsieur Clé. Il gère les commandes de la boutique WooCommerce, la comptabilité fournisseur, le stock, le SAV, les clés protégées et l'application Pro.

Cette documentation existe pour deux raisons, et il vaut mieux les dire :

Pour travailler — retrouver ce qu'un écran fait, pourquoi une règle existe, et ce qu'elle touche ailleurs.
Pour transmettre — si l'entreprise change de mains, ou si son propriétaire n'est plus là, quelqu'un doit pouvoir reprendre sans avoir à deviner. Ce n'est pas une précaution théorique : c'est la raison pour laquelle ce dossier a été écrit.

Par où commencer

Vous êtes…	Lisez d'abord
Un repreneur, un héritier, un acheteur	Si vous reprenez Darsy — tout ce qu'il faut savoir en une heure
Un développeur qui arrive	L'infrastructure, puis ARCHITECTURE.md
Quelqu'un qui doit déployer	DEPLOIEMENT.md
Quelqu'un qui cherche à quoi sert un écran	Le menu de gauche, groupe par groupe

Comment c'est organisé

Trois ensembles, dans cet ordre.

1. Si vous reprenez Darsy

Ce qu'il faut comprendre avant tout le reste, et où tourne quoi.

2. Les fonctionnalités

Un groupe par domaine, une page par écran.

Groupe	Ce qu'il couvre
Commandes	La liste, la fiche, la création, les règles
Stock	Les natures, les entrées et sorties, les entrepôts, la valorisation
Les clés	Profils de clé, catalogue clés
Comptabilité	Factures, banque, TVA, avoirs, LCR, salaires, irrégularités, variations tarifaires
Clients et fournisseurs	Clients, fournisseurs, SAV, contacts, comptes pro, avis
Pilotage et outils	Tableau de bord, analytics, attributions, export, audit, recherche
Administration	Utilisateurs et droits, sécurité, InnerPerf
Les systèmes à part	Mini-site SAV, Certi'Clé, application Pro, paiement différé, tarifs et organigrammes

3. Développement

Les carnets de bord, vivants : on y ajoute et on y coche au fil du travail.

Page	Ce qu'elle suit
Entreprise	Le développement de l'entreprise elle-même
Boutique en ligne	Les chantiers de la boutique
Darsy	Les chantiers de l'ERP

La convention d'écriture

Le métier d'abord, la technique à la fin

Chaque groupe se termine par une page « Le côté technique », signalée en rouge dans le menu.

Les pages métier — à quoi ça sert, ce qu'on peut y faire, ce que ça touche ailleurs, et les règles qu'on ne peut pas contourner. Écrites pour quelqu'un qui ne lit pas de code.
La page technique — les fichiers, les tables, les routes, les garde-fous et les pièges. Écrite pour quelqu'un qui va modifier.

Séparées mais voisines : un lecteur métier n'a pas à traverser des noms de fichiers, et un développeur trouve tout au même endroit.

Chaque document dit à qui il s'adresse

En tête de chaque fichier, quelques lignes que le lecteur ne voit pas :

---
groupe: Comptabilité
audiences: comptable, repreneur
resume: Une phrase qui dit ce que le document apporte.
---

Quatre publics : employe (celui qui s'en sert tous les jours), comptable (celui qui ne veut que les chiffres et leurs règles), repreneur (celui qui arrive et ne connaît rien), developpeur (celui qui va modifier).

La page Documentation de l'ERP demandera bientôt au lecteur pourquoi il est là, et n'affichera que ce qui le concerne. L'en-tête est ce qui le lui permettra — c'est pourquoi tests/Unit/DocumentationTest.php la réclame.

Les autres conventions

Le français pour le métier, l'anglais pour le code. Une facture est une facture ; une Response est une Response.
On dit pourquoi, pas seulement quoi. Une règle sans sa raison est une règle qu'on supprimera au premier obstacle.
On ne documente pas ce qui n'existe pas. Si une règle est dans nos intentions mais pas dans le code, elle est marquée comme telle.

Ces fichiers sont en Markdown, et c'est délibéré. Ils se lisent dans un éditeur de texte, sur GitHub, ou dans l'ERP (menu Documentation). Même si le serveur est mort et que plus rien ne tourne, le dossier docs/ reste lisible. Une documentation qui a besoin d'un serveur pour être lue ne sert à rien le jour où l'on en a le plus besoin.

Rien n'est codé en dur dans la page. Tout vient du dossier :

le nom du dossier ordonne les groupes — 20-commandes avant 30-comptabilite ;
le nom du fichier ordonne les pages — 10-, 20-, 30- ;
99-technique.md arrive donc toujours en dernier, et s'affiche en rouge ;
groupe: donne l'intitulé affiché, parce qu'un nom de dossier ne porte ni accent ni majuscule.

Ajouter une page, c'est ajouter un fichier. Rien d'autre.

Les documents à la racine du dépôt restent la référence sur leur sujet : ARCHITECTURE.md pour la structure technique, DEPLOIEMENT.md pour la mise en ligne.