cod == doc
summary
Argues that code should be treated as documentation and managed through the same lifecycle, illustrated with Criteo’s 3,000-employee codebase of millions of lines and tens of thousands of doc pages. Recommends practical tools and conventions—Markdown, Confluence/Notion, Javadoc, Swagger, ADRs, C4 architecture model—and building a linked knowledge graph from code, monitoring and templates, plus meta-documentation, KPIs and tools (e.g. getdevix.com) to auto-generate and measure docs for faster onboarding and more scalable projects.
AI-written summary · about
chapters (5)
- 0:00Introduction
- 1:00Code equals documentation
- 5:13Documentation scope
- 10:11Action plan for docs
- 14:03Measuring and improving docs
related talks
35mThe practical implementation of Documentation as Code
45mDocs as Code Fix a poor documentation culture in your organization
18mContinuous Documentation Manifesto
25mBuilding Docs like Code: Continuous Integration for Documentation
44mUseful and Beautiful Developer Docs and How to Create Them
26mWhy Docs-as-Code Peer Review Should be Part of your Dev Cycle
45mDocs or it didn't happen!
39mDevelopers Documentation: your hidden strength