Humanising Your Documentation - Carolyn Stransky from beyond tellerrand on Vimeo.Read more
I'm not sure if he actually came up with the term 'blogumentation' but software quality engineer Jamie Tanna features quite prominently when searching for it so at the very least he appears to be one of its more avid and deliberate users. Anyway, while the term 'blogumentation' might be somewhat obscure the concept behind this particular portmanteau is a seminal one. Basically, it derives from the insight that often the best way to learn and internalise knowledge is to talk, write and ...Read more
These days Swagger is a popular, easy-to-use tool for (semi-)automatically documenting REST APIs on-the-fly. For example, in order to document a REST API created with Spring Boot and Jersey literally all you have to do is add these two entries to your Maven pom.xml: You'll then get a ready-made documentation for all your REST API endpoints. An example of how this looks like can be seen here. While this already is very useful in that it helps with properly documenting your software, especially ...Read more
Continuing on last week's post about RunKit - a Node.js prototyping environment for the browser - here are two interesting tools that make use of RunKit: GitBook is a collaborative documentation tool that allows you to create beautiful, version-controlled documentation for your software. It's used by software components like Redux and it leverages RunKit to embed live, reactive code examples in your documentation.
Fieldbook is a database creation tool thats touted as "A database with an API – as simple as a spreadsheet". ...Read more