Skip to content

Docs Plan

Je vais d’abord explorer les SOP et les templates de documentation pour comprendre la structure attendue, puis analyser l’état actuel du projet pour créer un plan de documentation complet.

Je vais analyser l’état actuel du projet pour créer un plan de documentation complet selon les SOP et templates disponibles.

Basé sur mon analyse du projet actuel, voici un plan de documentation complet suivant les SOP et templates disponibles :

Le projet sera documenté selon l’architecture en 3 couches définie dans les SOP :

  • L1 - Contenu : Sanity CMS (schémas, studio, API)
  • L2 - Présentation : Astro SSR (composants, routes, layouts)
  • L3 - Backend : Cloudflare Workers (microservices, bindings)

🎯 Phase 1 : Documentation L1 - Contenu (Sanity)

Section titled “🎯 Phase 1 : Documentation L1 - Contenu (Sanity)”
  • docs/L1_Contenu/sanity/schemas/post.objectData.md
  • docs/L1_Contenu/sanity/schemas/author.objectData.md
  • docs/L1_Contenu/sanity/schemas/category.objectData.md
  • docs/L1_Contenu/sanity/schemas/blockContent.objectData.md
  • docs/L1_Contenu/sanity/schemas/amn.objectData.md
  • docs/L1_Contenu/sanity/schemas/submission.objectData.md
  • docs/L1_Contenu/sanity/studio/studio.objectData.md (configuration preview, environment variables)
  • docs/L1_Contenu/sanity/api/api.objectData.md (client configuration, preview mode)
  • docs/L1_Contenu/sanity/webhooks/webhook.objectData.md (si implémenté)
  • docs/L1_Contenu/sanity/visual-editing/visual-editing.objectData.md (si applicable)

🎨 Phase 2 : Documentation L2 - Présentation (Astro)

Section titled “🎨 Phase 2 : Documentation L2 - Présentation (Astro)”
  • docs/L2_Presentation/astro/config/config.objectData.md (astro.config.mjs, intégrations)
  • docs/L2_Presentation/astro/components/BaseHead.objectData.md
  • docs/L2_Presentation/astro/components/Header.objectData.md
  • docs/L2_Presentation/astro/components/HeaderLink.objectData.md
  • docs/L2_Presentation/astro/components/Footer.objectData.md
  • docs/L2_Presentation/astro/components/FormattedDate.objectData.md
  • docs/L2_Presentation/astro/layouts/BlogPost.objectData.md
  • docs/L2_Presentation/astro/layouts/MainLayout.objectData.md (si existe)
  • docs/L2_Presentation/astro/routes/index.objectData.md
  • docs/L2_Presentation/astro/routes/welcome.objectData.md
  • docs/L2_Presentation/astro/routes/blog-index.objectData.md
  • docs/L2_Presentation/astro/routes/blog-slug.objectData.md
  • docs/L2_Presentation/astro/routes/about.objectData.md
  • docs/L2_Presentation/astro/routes/contact.objectData.md
  • docs/L2_Presentation/astro/routes/api-preview.objectData.md
  • docs/L2_Presentation/astro/routes/api-exit-preview.objectData.md
  • docs/L2_Presentation/astro/routes/api-submit.objectData.md
  • docs/L2_Presentation/pagefind/indexing/indexing.objectData.md
  • docs/L2_Presentation/pagefind/search-api/search-api.objectData.md
  • docs/L2_Presentation/pagefind/search-ui/search-ui.objectData.md

⚙️ Phase 3 : Documentation L3 - Backend (Cloudflare)

Section titled “⚙️ Phase 3 : Documentation L3 - Backend (Cloudflare)”
  • docs/L3_Backend/cloudflare/config/config.objectData.md (wrangler.toml racine, ressources partagées)
  • docs/L3_Backend/cloudflare/workers/form-handler.objectData.md
  • docs/L3_Backend/cloudflare/workers/submission-processor.objectData.md
  • docs/L3_Backend/cloudflare/bindings/bindings.objectData.md (R2, KV, Queues)
  • docs/L3_Backend/cloudflare/functions/functions.objectData.md (si applicable)

🏗️ Phase 4 : Documentation Infrastructure & Process

Section titled “🏗️ Phase 4 : Documentation Infrastructure & Process”
  • docs/L1_Contenu/ADR/ADR L1.md (décisions architecture L1)
  • docs/L2_Presentation/ADR/ADR L2.md (décisions architecture L2)
  • docs/L3_Backend/ADR/ADR L3.md (décisions architecture L3)

4.2 Dossiers d’Architecture Technique (DAT)

Section titled “4.2 Dossiers d’Architecture Technique (DAT)”
  • docs/L1_Contenu/DAT/DAT L1.md (spécifications techniques L1)
  • docs/L2_Presentation/DAT/DAT L2.md (spécifications techniques L2)
  • docs/L3_Backend/DAT/DAT L3.md (spécifications techniques L3)
  • docs/PM/Phase0-Golden-Path.md (déjà existant)
  • docs/PM/Phase0-Matrice-Dependances.md (déjà existant)
  • docs/PM/Phase0-Ordre-Slices.md (déjà existant)

🚀 Phase 5 : Documentation Opérationnelle

Section titled “🚀 Phase 5 : Documentation Opérationnelle”
  • GettingStarted/01-setup-local.md (configuration environnement local)
  • GettingStarted/02-lancement-services.md (démarrage des 4 services)
  • GettingStarted/03-workflow-dev.md (flux de développement)
  • GettingStarted/04-tests-validation.md (procédures de test)
  • Mise à jour du Taskfile.yaml avec commentaires explicatifs

Selon le SOP, le projet actuel couvre partiellement les tranches suivantes :

Slice Statut Éléments Implémentés Documentation à Créer
Slice 1 : Page “amn” (vitrine) ✅ Complet Schéma amn, route /welcome, preview Sanity Toutes les fiches L1/L2 correspondantes
Slice 2 : Blog (posts) ✅ Complet Schémas post/author/category, routes blog, indexation Pagefind Toutes les fiches L1/L2 correspondantes
Slice 4 : Formulaire contact ✅ Complet Schéma submission, form-handler, submission-processor, Queue Toutes les fiches L1/L2/L3 correspondantes
Slice 3 : Portfolio ❌ Non implémenté - -
Slice 5 : Upload médias ❌ Non implémenté - -
Slice 6 : Webhook Sanity ❌ Non implémenté - -
Slice 7 : Backup & Cleanup ❌ Non implémenté - -
Slice 8 : Documentation & Recherche ⚠️ Partiel Starlight intégré mais non configuré Documentation Starlight à compléter

Recommandé selon le cycle de vie DOC → SPEC → CODE → TEST → INTÉG :

  1. Phase 1 : Documenter les schémas Sanity existants (L1)
  2. Phase 2 : Documenter les composants et routes Astro (L2)
  3. Phase 3 : Documenter les Workers Cloudflare (L3)
  4. Phase 4 : Créer les ADR et DAT pour chaque couche
  5. Phase 5 : Créer les guides GettingStarted pour les tests

Total estimé : ~35 fiches d’objets à créer + 3 ADR + 3 DAT + 4 guides opérationnels