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
Recently, tech writer Tom Johnson gave a webinar on trends in the field of API documentation, which I attended because this topic is relevant for my dissertation. Click here to access the slides and the recording of the webinar. The trends he found resulted from an online survey he conducted over the last two months.… Continue reading Trends in API documentation
Technical communicators might work as researchers or practitioners, or both. Stop reading if you belong to the former two groups. Keep reading if you somehow belong to both worlds. This blogpost introduces a tool that helps you to stay organised in academic writing: a reference management tool. Researchers already use this kind of tool as… Continue reading EndNote: Organise your references and save time when citing them
API docs and me 