A technical communicator's travel blog about the impressive land of developer experience and the deep waters of API usability
MkDocs—“make documentation”. 🤖 The static site generator MkDocs builds HTML output (a website) from Markdown source files, which you edit in the text editor of your choice, like Notepad++, Atom, Sublime or others. The very convenient thing about MkDocs is: it renders the output while you edit. That is, whenever you hit “Save” for the… Continue reading MkDocs: Write in Markdown, get a website
It's time for the Git cheat sheet for writers! Read why General command structure: command -o --option argument "another argument, containing blank spaces" Note that Git commands always start with the prefix git whereas Unix commands do not carry a prefix. Unix commandDescriptionpwdPrint working directory = tell me which folder I am inlsList all items… Continue reading Git & Unix cheat sheet
Part 1: Why you need to learn Git for Docs as Code Docs as Code. What? In the software industry, technical writers work close to developers, especially when writing developer documentation, that is, documents that have other developers as target users. The idea of Docs as Code is to employ the same workflows for the… Continue reading How I learned Git, forgot it, and re-learned it
Educating students on how to conduct usability tests is part of the MA programme I currently study (click here to enlarge the module map shown above). The product I decided to test was a developer portal, that is, a website aimed at developers and offering further information about microservices and their APIs. When shaping the… Continue reading Usability (testing) for complex information systems
Looking at technical documentation, the images you expect to see there would mainly be product photos or drawings, infographics, screenshots, or diagrams, depending on the product documented. As those images are directly related to the product, you would need to produce this type of media by yourself or hire somebody to do it for you.… Continue reading Pexels: Setting the mood—for stunning e-learning experiences
API docs and me 