Documenter son code¶

Documentation as code, docstrings, ADR et diagrammes — rendre le code comprehensible sans explications orales.

graph LR
    A["Fondamentaux"] --> B["Docstrings"]
    B --> C["ADR"]
    C --> D["Diagrammes"]
    D --> E["Doc API"]
    E --> F["Bonnes pratiques"]
    F --> G["Cas avances"]

Ce que vous allez apprendre¶

À la fin de ce tutoriel, vous serez capable de :

• Comprendre la pyramide de documentation et choisir le bon niveau
• Écrire des docstrings efficaces dans plusieurs langages
• Mettre en place des Architecture Décision Records dans votre projet
• Produire des diagrammes as code avec Mermaid et C4
• Générer une documentation d'API à partir d'annotations OpenAPI
• Appliquer les bonnes pratiques de maintenance de la documentation
• Déployer un site de documentation complet avec MkDocs ou Docusaurus

Prérequis¶

Parcours¶