Présentation

<h1 id="lab-pratique">Lab pratique</h1>

<h2 id="lab-outils">lab-outils</h2>

Lancement de votre parcours de développeur

<h3 id="démarrez-votre-aventure-en-informatique-avec-ce-guide-pratique-">Démarrez votre aventure en informatique avec ce guide pratique !</h3>

Ce laboratoire vous plonge dans l’univers du développement en vous familiarisant avec les outils essentiels. Vous allez installer votre environnement de travail, configurer votre ordinateur et découvrir des extensions utiles pour Visual Studio Code.

A la fin de ce parcours, vous aurez créé un site web simple pour suivre l’avancement de votre projet de fin de formation.

<h3 id="1-préparez-votre-ordinateur">1. Préparez votre ordinateur</h3>

<ul>
 <li>Windows 10 ou plus récent: Assurez-vous d’avoir une version récente de Windows installée.</li>
 <li>Configuration développeur: Optimisez Windows pour le développement en installant les mises à jour et en activant les fonctionnalités nécessaires.</li>
 <li>Visual Studio Code: Installez cet éditeur de code open source très populaire parmi les développeurs.</li>
</ul>

<h3 id="2-enrichissez-votre-environnement-de-développement">2. Enrichissez votre environnement de développement</h3>

<ul>
 <li>Correcteur d’orthographe: Installez l’extension “Code Spell Checker” pour vérifier l’orthographe et la grammaire de votre code.</li>
 <li>Gestionnaire de tâches: Installez l’extension “Todo Tree” pour organiser vos tâches et listes de choses à faire.</li>
 <li>Edition d’images: Installez une extension comme ImageMagick ou GIMP pour manipuler des images dans votre code.</li>
</ul>

<h3 id="3-mini-projet-site-web-de-suivi-de-projet">3. Mini-projet: Site web de suivi de projet</h3>

Objectif: Développez un site web simple pour suivre l’avancement de votre projet de fin de formation.

Étape 1: Définir votre projet

<ul>
 <li>Choisissez un sujet: Sélectionnez un projet qui vous motive et correspond à vos objectifs d’apprentissage.</li>
 <li>Découpage en étapes: Divisez votre projet en étapes gérables, chacune avec des objectifs et des livrables clairs.</li>
</ul>

Étape 2: Création du site web

<ul>
 <li>Fichiers HTML: Créez un fichier HTML minimaliste pour chaque étape, listant les tâches à accomplir. Omettez le CSS pour l’instant.</li>
 <li>Fichier CSS: Créez un fichier CSS pour styliser l’apparence de vos pages HTML.</li>
 <li>Tâches Todo: Ajoutez des instructions Todo dans chaque fichier HTML pour chaque tâche, en utilisant des commentaires ou des extensions dédiées.</li>
 <li>Organisation des fichiers: Rassemblez vos fichiers dans un dossier nommé “docs”.</li>
</ul>

Étape 3: Déploiement et partage

<ul>
 <li>Dépôt GitHub: Créez un référentiel GitHub et déposez-y l’ensemble de vos fichiers.</li>
 <li>GitHub Pages: Configurez GitHub Pages pour déployer vos pages HTML et les rendre accessibles en ligne.</li>
 <li>Partagez votre site web: Présentez le lien de votre site web à d’autres personnes pour leur montrer votre progression.</li>
</ul>

<h3 id="félicitations-">Félicitations !</h3>

Vous avez franchi vos premiers pas dans le monde du développement ! Ce site web vous servira de base pour suivre l’avancement de votre projet de fin de formation. N’hésitez pas à l’enrichir et à le personnaliser au fil de votre progression.

<h2 id="lab---rédiger-une-documentation-technique-claire-et-efficace-avec-le-code">Lab - Rédiger une documentation technique claire et efficace avec le code</h2>

<h3 id="importance-de-la-documentation">Importance de la documentation</h3>

<h4 id="les-atouts-du-code-pour-sa-rédaction">Les atouts du code pour sa rédaction</h4>

Le code : un outil puissant pour documenter les applications

De nombreux développeurs privilégient le code aux interfaces graphiques (IG) pour documenter les applications logicielles. Ce choix s’explique par plusieurs avantages considérables :

<ul>
 <li>Facilité de modification : Les fichiers texte offrent une flexibilité et une précision accrues lors de la modification du contenu.</li>
 <li>Gestion aisée des versions : Les systèmes de contrôle de version facilitent le suivi des modifications et la restauration de versions antérieures.</li>
 <li>Automatisation des tâches : Le code peut être automatisé pour rationaliser les tâches répétitives.</li>
 <li>Documentation claire et concise : Markdown et PlantUML permettent de créer une documentation claire et informative à l’aide de fichiers texte simples.</li>
 <li>Portabilité : Le code est indépendant de la plateforme et peut être exécuté sur différents systèmes.</li>
</ul>

<h4 id="une-documentation-complète--un-atout-majeur-pour-les-applications-logicielles">Une documentation complète : un atout majeur pour les applications logicielles</h4>

Au-delà des avantages du code, une documentation complète procure de nombreux bénéfices :

<ul>
 <li>Communication claire et fluide : Elle facilite la communication entre les utilisateurs, les développeurs et les parties prenantes.</li>
 <li>Maintenance aisée et évolutivité : Elle permet une maintenance simplifiée et une évolution future de l’application.</li>
 <li>Réduction des coûts : Elle réduit les coûts et les délais liés au débogage et à l’ajout de fonctionnalités.</li>
 <li>Apprentissage et formation simplifiés : Elle facilite l’apprentissage et la formation des nouveaux utilisateurs et développeurs.</li>
 <li>Préservation des connaissances : Elle préserve les connaissances acquises et assure la continuité du savoir-faire.</li>
</ul>

La documentation : un élément crucial pour la réussite d’une application

La documentation d’une application informatique est essentielle pour sa réussite. En utilisant le code et des outils adaptés, les développeurs peuvent créer une documentation claire, efficace et maintenable, garantissant ainsi la longévité et la valeur de l’application.

<h3 id="mini-projet--documenter-votre-projet-de-fin-de-formation">Mini projet : Documenter votre projet de fin de formation</h3>

Objectif: Réaliser une documentation claire et professionnelle pour votre projet de fin de formation en utilisant GitHub Pages et Jekyll, avec des diagrammes PlantUML et Mermaid.

Compétences:

<ul>
 <li>Maîtrise du projet et des technologies employées</li>
 <li>Git</li>
 <li>Markdown, PlantUML et Mermaid</li>
 <li>Jekyll et GitHub Pages</li>
</ul>

Déroulement:

<ol>
 <li>Analyse du projet: Identifiez les fonctionnalités, utilisateurs et objectifs.</li>
 <li>Définition du périmètre: Déterminez les éléments à documenter.</li>
 <li>Rédaction:
 <ul>
 <li>Structurez la documentation de manière claire et logique.</li>
 <li>Rédigez des instructions détaillées et précises pour chaque fonctionnalité.</li>
 <li>Intégrez des captures d’écran, diagrammes et exemples de code.</li>
 <li>Utilisez Markdown et PlantUML pour créer une documentation visuelle.</li>
 <li>Réalisez des diagrammes explicites avec PlantUML et Mermaid.</li>
 </ul>
 </li>
 <li>Mise en ligne:
 <ul>
 <li>Créez un référentiel GitHub pour le projet et configurez-le pour héberger la documentation.</li>
 <li>Installez Jekyll et configurez-le pour générer la documentation à partir des fichiers Markdown.</li>
 </ul>
 </li>
 <li>Test et validation: Testez la documentation sur différents navigateurs et appareils.</li>
 <li>Amélioration et finalisation: Révisez la documentation en tenant compte des commentaires et apportez les modifications nécessaires.</li>
</ol>