Procédure de rédaction d'un cours

[Robert-Scub]

Repositories

https://github.com/Robert-Scub/formation-flutter

https://github.com/Robert-Scub/flutter-edtech

Mise en place

Objectif: Démontrer une fonctionnalité par un exemple de code. Une introduction présente le concept puis un ou plusieurs steps exécute votre application. La conclusion résume ce qui a était présenté.

• Forker la branche main
• La nommer avec le nom du ticket
• Créer un dossier correspondant avec le script adéquat
• S'il y a plusieurs steps créer un sous-projet par step
• ajouter un lien vers le repository
• ajouter un lien vers zapp

Comment créer un projet

Suivi

Mettre le ticket en cours. 1 ticket en cours à la fois

Contenu éditorial

Un cours est constitué d'une introduction ainsi que de zéro pour plusieurs étapes de code et éventuellement une conclusion.

On demande un paragraphe d'introduction puis un paragraphe par point à éclaicir.

Le code cité est entre backticks: exemple void maMethode()

• La méthode main est commentée et recapitule l'objet de l'exercice. 2/3 lignes.
• Chaque méthode est commentée ainsi que les points spécifiques
• On limite le nombre de fichiers pour que tout reste dans main.dart sauf si problème de lisibilité.

Sections:

• Références (liens externes comme flutter.dev ou l'api)
• Vocabulaire

Publication

Remplir le champs publishDate pour le faire apparaitre.

Format et validation

• Les méthodes sont toutes commentées avec ///
• Les explication sont commentées avec seulement //
• On ne commit pas tant que l'ide donne des warnings!!!
• On respecte la mise en page du code dart
• Votre app ne s'appelle surtout pas MyApp! elle contient le nom du sujet.

[meriem-scub]

-