Aller au contenu principal

Nettoyage de la Documentation

Dernière mise à jour : 2026-03-07
Objectif : Supprimer le superflu, mutualiser, et marquer ce qui n'est plus d'actualité.

Principes​

  • Point d'entrée unique : ROADMAP.md → PRIORITES.md et PLAN_AMELIORATIONS_CRM.md.
  • Pas de doublons : Un seul document "source de vérité" par thème ; le reste pointe vers lui ou est archivé.
  • Historique vs actuel : Les docs "phase terminée" ou "status final" peuvent être fusionnés dans un seul fichier d'archive par domaine (ex. docs/archive/) ou réduits à une section "Historique" en bas du doc principal.

1. À supprimer (obsolète ou redondant)​

FichierRaisonStatut
INSTRUCTIONS_CHATGPT.mdInstructions pour un autre agent ; hors périmètre Cursor/agents du repo.✅ Supprimé
REFACTORING_PHASE6_PLAN.mdPlan détaillé Phase 6.1/6.2 (historique). Contenu en git history.✅ Supprimé

2. À mutualiser / fusionner​

2.1 Frontend refactoring (terminé)​

  • Garder : FRONTEND_IMPROVEMENT_PLAN.md comme doc principale (mettre à jour le statut : refactoring 400 lignes terminé, retirer la liste "fichiers restants" si tout est fait).
  • Réduire : FRONTEND_NEXT_STEPS.md à une courte page "Optimisations futures" (lazy loading, virtualisation, etc.) + lien vers FRONTEND_IMPROVEMENT_PLAN. Éviter de dupliquer l'historique.
  • Archiver ou raccourcir : FRONTEND_REFACTORING_RESTANTS.md — liste des 32 fichiers refactorisés. Soit déplacer en docs/archive/frontend-refactoring-complete.md, soit garder une version courte "Refactoring terminé (32 fichiers)" dans FRONTEND_IMPROVEMENT_PLAN.

2.2 Backend refactoring (phases terminées) ✅​

2.3 Stack Python ✅​

2.4 Billing ✅​

2.5 Workers ✅​

3. À actualiser (plus d'actualité)​

DocumentAction
FRONTEND_IMPROVEMENT_PLAN.mdIndiquer que le refactoring "< 400 lignes" est terminé. Retirer ou mettre à jour la section "Fichiers restants" (si 0 restant). Aligner les chiffres avec FRONTEND_REFACTORING_RESTANTS.
ROADMAP.mdVérifier la section "En cours" / "Implémentations à venir" : ne pas lister deux fois la même chose (ex. Refactor hooks quotes/invoices déjà en "complété"). Racourcir "Dernières évolutions" si trop long (garder les 6–12 derniers mois).
docs/README.md (documentation technique)Vérifier que tous les liens pointent vers des fichiers existants. Supprimer ou mettre à jour les références aux docs fusionnés/supprimés.
AGENTS.md (racine)Déjà un redirect vers docs/ ; rien à faire sauf si d'autres liens cassés.

4. Structure recommandée après nettoyage​

docs/
├── AGENTS*.md           # Guidelines agents (inchangé)
├── ROADMAP.md           # Point d'entrée
├── PRIORITES.md
├── PLAN_AMELIORATIONS_CRM.md
├── FRONTEND_IMPROVEMENT_PLAN.md   # + statut refactoring à jour
├── FRONTEND_NEXT_STEPS.md         # Court : optimisations futures
├── BACKEND_STRUCTURE_IMPROVEMENT_PLAN.md
├── DOCUMENTATION_CLEANUP.md       # Ce fichier
├── README.md                      # Index mis à jour
├── archive/                       # Historique
│   ├── backend-refactoring-archive.md
│   ├── python-stack-archive.md
│   ├── billing-archive.md
│   └── workers-archive.md
├── fiscal/
├── getting-started/
└── ... (feature docs conservés)

5. Actions effectuées (suivi)​

  • 2026-03-07 : Refonte de l’index docs/README.md pour un mode "active docs first", ajout de la gouvernance documentaire dans docs/AGENTS.md et docs/AGENTS_PATTERNS.md, ajout des skills locaux:
    • .agents/frontend-performance/SKILL.md
    • .agents/docs-performance/SKILL.md et mise à jour de agents.md (racine) pour exposer ces skills.
  • 2026-03-07 (archivage sécurisé) :
    • docs/FRONTEND_REFACTORING_RESTANTS.md réduit en page synthèse + pointeur archive.
    • Historique complet déplacé vers docs/archive/frontend-refactoring-complete.md.
    • Documents non référencés archivés:
      • docs/archive/plan-flux-projet-sessions.md
      • docs/archive/invitations-friends-documentation-update.md
      • docs/archive/google-oauth-form-responses-en.md
      • docs/archive/prompt-chatgpt.txt
    • Ajout d’un index d’archive: docs/archive/README.md.
  • 2026-03-07 (lot orphelins) :
    • Archivage des docs sans références actives:
      • CALENDAR_DATA_FLOW.md
      • CRM_DOCUMENTATION.md
      • DISCORD_WEBHOOK_SETUP.md
      • DOCUMENTATION_SITE.md
      • DOCUMENTS_ROADMAP.md
      • DOCUMENTS_USE_CASES.md
      • DOCUMENT_PROCESSING_SYSTEM.md
      • GLOBAL_SEARCH_IA_FLOW.md
      • GMAIL_CLEANUP_GUIDE.md
      • GOOGLE_OAUTH_VERIFICATION_GUIDE.md
      • LEAD_FORMS_PUBLIC.md
      • MIGRATION_ROLE_TO_PERMISSIONS.md
      • PAYMENTS_REMINDERS_PLAN.md
      • REDIS_INSIGHT_SETUP.md
      • REFACTORING_CIRCULAR_DEPENDENCIES.md
    • Nettoyage des liens docs-site (docs-site/sidebars.js) pour éviter les entrées cassées.
  • 2026-03-07 (suppression définitive) :
    • Suppression des artefacts sans valeur de traçabilité:
      • docs/archive/prompt-chatgpt.txt
      • docs/archive/google-oauth-form-responses-en.md
  • 2026-03-07 (mutualisation skills) :
    • Fusion des skills locaux dans un seul répertoire .agents/.
    • Déplacement des skills legacy depuis .agent/skills/* vers .agents/*.
    • Suppression du répertoire .agent devenu vide.
  • 2026-02-25 : Rédaction de ce plan (supprimer / mutualiser / actualiser). Mise à jour de FRONTEND_IMPROVEMENT_PLAN.md (statut refactoring, section "Fichiers restants" remplacée par un lien vers FRONTEND_REFACTORING_RESTANTS). FRONTEND_NEXT_STEPS.md raccourci (optimisations futures + liens, suppression du doublon "refactoring terminé").
  • Backend refactoring, Python, Billing, Workers : consolidations effectuées. INSTRUCTIONS_CHATGPT et REFACTORING_PHASE6_PLAN supprimés.
  • 2026-02-25 (suivi liens) : Liens corrigés : PLAN_AMELIORATIONS_CRM et PRIORITES (Billing → BILLING.md + archive), PYTHON_STACK_IMPLEMENTATION (liens vers EVOLUTION + archive), README racine (Python → PYTHON_STACK_EVOLUTION). Section ROADMAP « janvier 2026 » peut être raccourcie à la main si besoin.
  • 2026-02-25 (cosmétique) : Section 1 (table) et sections 2.2–2.5 mises à jour : statut "Fait" et liens vers les archives. Structure §4 alignée avec les archives créées.

6. Références​

  • Premier nettoyage (décembre 2024) : consolidation plan frontend, suppression de FRONTEND_IMPROVEMENTS_*.md redondants.
  • Règle ROADMAP : éviter plusieurs "plans" parallèles ; nouveau plan = court, actionnable, référence PRIORITES.md.