Posts Tagged: documentation

Home » documentation

(English) Don’t Just Document Software, Tell a Story.

Leider ist der Eintrag nur auf Britisches Englisch verfügbar.Humans tend to remember stories much better than mere facts, which probably is why storytelling has such a long tradition in human history. Storyteller is - quoting from their own description - an "editor plugin that generates web pages that recreate and animate entire programming sessions" (see this playback repository for examples and the project's GitHub repository for more details). It's an interesting, novel take on software documentation in that instead of merely describing some ... Read more

(English) Humanising Your Documentation – Carolyn Stransky @ beyond tellerrand 2019

Leider ist der Eintrag nur auf Britisches Englisch verfügbar. Humanising Your Documentation - Carolyn Stransky from beyond tellerrand on Vimeo. Read more

(English) Dinero.js: Working With Monetary Values in JavaScript

Leider ist der Eintrag nur auf Britisches Englisch verfügbar.Working with monetary values can become a problem in any programming language and JavaScript certainly is no different in that respect. The naïve assumption that monetary values can be expressed as floating point numbers almost inevitably leads to rounding errors caused by precision and the fact that in most cases monetary values are represented as decimal numbers with just two (instead of an undefined number of) decimal places. Apart from that, money is not ... Read more

(English) Blogumentation

Leider ist der Eintrag nur auf Britisches Englisch verfügbar.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 ... Read more

(English) Using Swagger to Generate Client SDKs for REST APIs

Leider ist der Eintrag nur auf Britisches Englisch verfügbar.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 ... Read more

(English) Documentation and Spreadsheets with an API: GitBook and Fieldbook

Leider ist der Eintrag nur auf Britisches Englisch verfügbar.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 ... Read more