Living Documentation

Tu ne le sais pas encore, mais tu l’as deja documenté!

Ouvrir les exemples
Vérifier leur fonctionnement
RevealJs shortcuts
- Alt+clic : Zoom in/ Zoom out
- O/Esc : Slide overview
- M : Menu
- ? : show keyboard shortcuts
- C : chalkboard overlay
- B : chalkboard modal
- D : Download chalkboard
- S : presenter mode
- V : Fade to black
- F: fullscreen → Esc : exit fullscreen

thanks-software-crafters-lyon.adoc

sections/who_am_I.adoc

⚠️ Disclaimer

Cette présentation contient des démos foireuses

sections/ok_first_some_questions.adoc

Agenda

The Story of an onboarding
Living Documentation FTW
A ton of examples!
Some Takeaways

sections/r_bad_onboarding.adoc

sections/the_problem_with_traditional_documentation.adoc

sections/what_is_documentation.adoc sections/ok_already_there.adoc sections/new_documentation_approaches.adoc

sections/ok_interlude_01.adoc sections/examples_please.adoc

source_code_itself.adoc

sections/from_test_code.adoc sections/ok_doctest.adoc sections/ex_javadoc_code_snippets.adoc sections/ex_tests_as_documentation.adoc

sections/ex_architecture_tests.adoc

sections/interlude_02.adoc

Tools to get insight from code

word_cloud.adoc

embedded_learning.adoc

sections/ex_living_glossary.adoc

sections/ok_diagram_as_code.adoc

sections/ok_code_analysis.adoc sections/ex_code_tour.adoc

sections/interlude_03.adoc

sections/from_conversations.adoc

sections/ex_notebooks.adoc sections/ex_frontend_documentation.adoc

sections/ex_presentation_as_code.adoc

sections/interlude_04.adoc

sections/ex_vcs_based_documentation.adoc sections/ok_your_code_as_a_crimescene.adoc

sections/ex_markdown_readme.adoc sections/ex_wiki_as_code.adoc sections/warm_welcome.adoc

sections/interlude_05.adoc

sections/ok_architecture_decisions_records.adoc sections/ok_accessibility_audit_as_code.adoc sections/ok_technology_radar.adoc

sections/ex_declarative_infrastructure.adoc

sections/ok_your_tools_and_ide_features.adoc sections/from_manual_to_automated.adoc

sections/ok_api_contracts_and_tests.adoc

sections/interlude_06.adoc

6_conclusion.adoc

sections/takaway_automation_has_a_cost.adoc

ok_thanks_slides_infos_lyon.adoc