Documentation pilotée par README et LLM Wiki

Idée centrale

Une documentation pilotée par README et un LLM Wiki reposent sur une base commune : des connaissances lisibles, proches du travail, versionnées et accessibles par routage progressif. Elles diffèrent surtout par l’unité de connaissance, les sources mobilisées et la responsabilité de maintenance.

SRC-2026-005 compare ces deux approches à partir d’un retour d’expérience logiciel. Cette page en reconstruit les critères sans transformer ses conventions locales en règles universelles.

Fondation commune

Les deux approches peuvent partager :

Le fichier de règles agit comme un routeur, pas comme un conteneur exhaustif de connaissances.

Comparaison

DimensionDocumentation par READMELLM Wiki
unité principalemodule, service ou sujet possédé par une équipeconnaissance transversale ou synthèse multi-source
auteur principaldéveloppeur ou équipe responsablemodèle sous gouvernance humaine
sourcescode et contexte immédiat du moduleREADME, code, historique, décisions, incidents et autres sources admises
structuregénéralement définie à l’avancepeut évoluer avec les concepts et relations
mise à jouravec le changement de code et sa revueingestion ou synchronisation ciblée, puis audit
portéeprojet et responsabilités localesrelations entre modules, systèmes ou corpus hétérogènes
source de véritédocumentation collective versionnéecouche canonique selon sa gouvernance ; parfois synthèse personnelle dérivée
risque principaldérive manuelle et silos par modulesynthèse erronée, duplication ou divergence non revue

Routage progressif

Un fichier d’instructions peut établir :

  1. les règles générales ;
  2. un ordre de lecture ;
  3. des correspondances entre type de tâche et document ;
  4. une délégation vers le README ou la page pertinente.

Le même principe s’applique à l’index d’un wiki : commencer par la carte, sélectionner quelques pages candidates, puis suivre les relations nécessaires. Le nombre de pages et la profondeur doivent être adaptés au risque et à la complexité, non copiés depuis une implémentation particulière.

Quand les README peuvent suffire

Une documentation de dépôt bien structurée peut être suffisante lorsque :

Dans ce cas, créer un wiki séparé peut ajouter une couche de maintenance sans bénéfice démontré.

Quand le wiki devient utile

Une couche de wiki est justifiée lorsque les réponses importantes exigent :

Synthèse éditoriale : la complexité transversale est un meilleur déclencheur que la taille brute du dépôt.

Coexistence et autorité

Un wiki personnel ou expérimental ne doit pas remplacer silencieusement la documentation d’équipe. Les README et décisions versionnés peuvent rester les références collectives, tandis que le wiki sert de couche de synthèse.

Lorsqu’une connaissance du wiki doit devenir normative pour l’équipe, elle doit être promue vers la documentation partagée ou soumise à une politique de revue équivalente. Cette règle complète la Gouvernance humaine des modifications par LLM.

Fraîcheur

Deux mécanismes sont complémentaires :

Une empreinte ou une révision identique prouve la stabilité de l’artefact comparé, pas la vérité de l’interprétation. Voir Provenance structurelle des connaissances.

Progression possible

Synthèse éditoriale :

  1. commencer par un README utile et un fichier de règles qui route ;
  2. ajouter une arborescence de documents pour l’architecture, les décisions, modules et intégrations ;
  3. créer un wiki sur le sous-système où les connaissances importantes restent dispersées ;
  4. étendre seulement après mesure des bénéfices et du coût de maintenance.

Cette progression n’impose aucun seuil de fichiers ou de pages.

Erreurs fréquentes

Limites et nuances

La comparaison provient d’un seul retour d’implémentation. Le dépôt, le wiki et les mesures ne sont pas disponibles dans le corpus. La page décrit donc un cadre de décision et non une supériorité démontrée d’une approche.

Relations

Sources