Skill · Documentation · Document a service or a project
Write a clear, accessible and verifiable technical page
Write a Markdown page that answers first, in short sentences, with steps whose expected result is observable, nested headings and explicit links.
Start lesson 1The Documentation domain
- 3 lessons
- ~1 h 25 of reading
- 3 quizzes
- 0 proof lab
The path
Where it comes from, where it leads
What you need to know first, where you stand on this skill, and what it opens next. Your status is computed in your browser, from what you have read and passed.
Before · no prerequisite
A foundation skill: you can start right away.
Recommended before · 1
This skill, for you
Write a clear, accessible and verifiable technical page
Computing
It unlocks · 1 skill
The path through the foundations From the most upstream foundation to this skill: what is in place, what remains to read.
Lessons
How to learn it
3 lessons, about ~1 h 25, in program order. Each lesson ends with its quiz.
The program
3 lessons · ~1 h 25
Beyond the lessons
Assess, practise, pass the proof
Reading a lesson confirms nothing. A skill is confirmed by a passed quiz, practised in a guided lab, and put to the test by a challenge or a mission; an imported lab result is not verified by the site.
Assess yourself
3 quizzes
At the end of the lessons: passed at 70%, they confirm the skill.
Practice
No guided lab
No guided lab practices it yet.
Proof
No proof
Neither a challenge nor a mission with a proof yet.
Placement test
Preparing the questions…
Your answers in detail
For each question asked: your answer, the correct answer, its explanation and the page to reread.
Around it
Who requires it, who teaches it
Required by
Taught by
Same block · Document a service or a project
- Choose the document type and its reader before writing
- Give a repository its README, CHANGELOG and ADRs
- Represent a system with diagrams as code that read without the image
- Keep documentation alive: owner, review, freshness
- Build and publish documentation checked in CI
- Document code: comments that say why, docstrings, generated reference
- Model an architecture beyond context: components, dynamic and deployment views, a single model in code
- Write a technical document in AsciiDoc: structure, attributes, blocks and conversion
- Build a technical presentation in Markdown or HTML, versioned and exported