Write Super-powered Documentation with Cognitive Breakpoints
Software engineers famously hate writing documentation. I get it: it is hard! Reading documentation isn't all fun and games either. We need a new approach.
Cognitive Breakpoints are like responsive-design for documentation. They allow readers to choose their own adventure on how much complexity they want and free documentation writers to pour all the detail they want into the docs without worrying about overwhelming the user.
00:00 - Intro
00:14 - The problem with Documentation
00:37 - Introducing cognitive breakpoints
01:28 - A real-world example
03:55 - How to write this new documentation
08:00 - Potential next steps
Source code: https://github.com/semanticart/cognit...
Example: https://semanticart.com/json-rpc-cogn...