Doter un dépôt de son README, de son CHANGELOG et de ses ADR

Écrire le README qui fait démarrer un inconnu, tenir un CHANGELOG au format Keep a Changelog et tracer une décision dans un ADR avec options et conséquences.

Commencer la leçon 1 Le domaine Documentation

2 leçons
~1 h 00 de lecture
3 quiz
0 lab de preuve

Le chemin

D'où elle vient, où elle mène

Ce qu'il faut savoir avant, où vous en êtes sur cette compétence, et ce qu'elle ouvre ensuite. Votre état se calcule dans votre navigateur, à partir de ce que vous avez lu et réussi.

Avant · aucun prérequis

Une compétence de base : vous pouvez commencer tout de suite.

Conseillé avant · 3

Cette compétence, pour vous

Doter un dépôt de son README, de son CHANGELOG et de ses ADR

Calcul en cours

Elle débloque · rien encore

Aucune autre compétence ne la demande : c'est une compétence de bout de chemin.

Leçons

Comment l'apprendre

2 leçons, soit ~1 h 00, dans l'ordre du programme. Chaque leçon se termine par son quiz.

Le programme

2 leçons · ~1 h 00

1README et CHANGELOG : l'entrée et l'historique d'un dépôt· 25 min
2Architecture Decision Records (ADR) : tracer vos choix· 35 min

Au-delà des leçons

S'évaluer, pratiquer, passer l'épreuve

Lire une leçon ne confirme rien. Une compétence se confirme par un quiz réussi, se travaille en lab guidé, et se met à l’épreuve par un challenge ou une mission ; un résultat de lab importé n’est pas vérifié par le site.

S'évaluer

3 quiz

En fin de leçon : réussis à 70 %, ils confirment la compétence.

Pratiquer

Aucun lab guidé

Aucun lab guidé ne la fait encore pratiquer.

Épreuve

Aucune épreuve

Ni challenge, ni mission avec une preuve pour l'instant.

Appliquer sur une vraie infrastructure

Documenter une décision d'infrastructure avec un ADR

Des leçons de mise en pratique : leurs labs comptent comme pratique et leurs quiz vous évaluent, sans être exigés pour l'acquérir.

Autour

Qui la demande, qui l'enseigne

Demandée par

Enseignée par

Documenter

Même bloc · Documenter un service ou un projet