skip to content
Go back Go back

The ReadME Project presents: Using code as documentation to save time and share context

Documentation exists in many different forms. There is, of course, traditional documentation, such as tutorials and manuals that live outside of a codebase. But there are other ways to capture and codify procedures or share context-specific knowledge, including code comments, config files, templates, and automation.

These forms of documentation are powerful because they exist in the places where you’re most likely to use them, whether that’s within a chunk of code or inside your IDE. In this session, you'll learn about different ways to store and present information to save your future self time and hassle, and help colleagues or open source contributors work more effectively.