README.md

Codexia Documentation

Codexia est un projet vitrine professionnel démontrant l'étendue complète du spectre de compétences d'un développeur expert : de l'infrastructure système à la gouvernance projet, en passant par le développement, la sécurité, l'accessibilité et la qualité web.

Ce dépôt contient la documentation complète du projet Codexia, rédigée selon la philosophie "Documentation as Code" : versionnée, revue et déployée avec la même rigueur que le code source.

🚀 Démarrage rapide

Vision et philosophie

Accessibilité

Design et UI

Pilotage et méthodologie

  • 📋 Scrum (Méthodologie) - Organisation Scrum solo
  • 🎯 Domaines d'expertise - 10 domaines (SysAdmin → Gouvernance)
  • 🗺️ Roadmap - Décisions et axes de travail

Base de connaissance IA

  • 🤖 Base de connaissance IA (59 fiches) - Comprendre, choisir et déployer l'IA en entreprise : fondements techniques, modèles du marché, prompt engineering, cas d'usage par métier, éthique, sécurité, conduite du changement et pilotage

Référence

📦 Projets liés

Projet Description Repository
telaria (ex-codexia) Application Symfony 8.0 (PHP 8.5) — produit vitrine Codexia github.com/<owner>/telaria
telaria-doc Documentation (ce dépôt) github.com/<owner>/telaria-doc

📂 Structure du dépôt

telaria-doc/
├── accessibility/              # 5 documents accessibilité (RGAA AA)
├── agents/                     # Base de connaissance IA (59 fiches, 10 modules + annexes)
├── bundles/                    # Documentation bundles Symfony
├── guides/                     # Guides techniques (déploiement, SSL, etc.)
├── pilotage/                   # Méthodologie Scrum, roadmap, veille
├── rfc/                       # Spécifications officielles (RFC)
├── specs/                      # Spécifications (architecture, design, UI)
├── templates/                  # Templates réutilisables
├── tools/                      # Outils (tlr-cli, etc.)
├── tutos/                      # Tutoriels (Markdown, SVG)
├── vision/                     # Philosophie, ingénierie, domaines d'expertise
├── scripts/                    # Outillage qualité doc (vérif liens, hooks) — "doc as code"
├── .github/workflows/          # CI : vérifications doc (liens, EOL)
├── inputs/legacy/                     # Archive historique (lecture seule)
├── .gitattributes              # Normalisation LF + UTF-8
├── CHANGELOG.md                # Historique modifications
├── toc.md                      # Table des matières
├── glossaire.md                # Glossaire des acronymes
└── README.md                   # Ce fichier

Règles importantes

  • ✅ « Documentation pure » = pas de code produit : Markdown + ressources, plus l'outillage qualité du dépôt (scripts/, .github/workflows/, .gitattributes — Documentation as Code). Le code dans les .md reste illustratif.
  • ✅ Documentation à la racine : Tous les .md sont directement accessibles
  • ❌ Ne pas toucher /legacy : Archive figée en lecture seule (sera supprimé pour la mise en production)
  • 📝 Mettre à jour CHANGELOG.md : À chaque modification significative

🎯 Philosophie du projet

La documentation est le produit

Codexia traite la documentation comme un produit de premier ordre :

  • Auto-documentation : Le projet explique son propre fonctionnement
  • Documentation as Code : Versionnée, revue, déployée
  • Transparence totale : Décisions, échecs, hésitations documentés

Vitrine de savoir-faire

Codexia démontre 10 domaines d'expertise :

  1. SysAdmin - Infrastructure serveur (Ubuntu, Apache, MySQL)
  2. SecOps - Sécurité opérationnelle (SSL/TLS, firewall, audits)
  3. DevOps - Automatisation et CI/CD (tlr-cli, Ansible)
  4. Backend - Développement Symfony (API, Doctrine, Voters)
  5. Frontend - Interface utilisateur (Twig, Stimulus, Bootstrap)
  6. Accessibility - Conformité RGAA 4.1 niveau AA
  7. Quality - Bonnes pratiques Opquast
  8. Privacy - RGPD et protection des données
  9. AI - Collaboration humain-IA
  10. Gouvernance - Pilotage Scrum et roadmap

Pragmatisme et longévité

  • Technologies éprouvées : PHP/Symfony, MySQL, Apache
  • Simplicité volontaire (KISS) : Fondations solides et maintenables
  • Inspiré par les "dinosaures" : Redmine, Jira - qui durent grâce à leur robustesse

📚 Documentation détaillée

Guides techniques

Tutoriels

Bundles

🤝 Contribution

Workflow de contribution

  1. Lire la documentation existante : Consultez toc.md pour la structure
  2. Créer une branche : CDX-XXX-description
  3. Modifier à la racine : Jamais /legacy
  4. Mettre à jour CHANGELOG.md : Section [Non publié]
  5. Commit : docs: description de la modification
  6. Pull request : Vers develop

Standards de rédaction

Conventions complètes (structure, nommage, cartouche de document, rédaction) : voir DOCUMENTATION.md.

  • Markdown : Format standard, balisage sémantique
  • Cartouche : Tout document s'ouvre par un cartouche front-matter (voir DOCUMENTATION.md)
  • Français : Langue principale (traduction EN prévue)
  • Clarté : Langage simple, phrases courtes
  • Accessibilité : Liens explicites, alternatives textuelles, structure hiérarchique

📜 Licence

Documentation sous licence libre (à définir).

📞 Contact

  • Auteur : Mathieu Adrien
  • Entreprise : Telaria

Assistant documentaire

Posez une question sur la documentation. Les réponses citent leurs sources — un clic ouvre le document à gauche.
Loading…
Loading the web debug toolbar…
Attempt #