Uncategorized – Page 2

From larva to pupa

After some initial reservations about my intentions, Nextory agreed to let me document their API. All of the ins and outs are being managed through Upwork so both parties know what to expect. I’m very grateful that Daniel (my contact at Nextory) took a chance on me and gave me this opportunity. I did emailContinue reading “From larva to pupa”

Learning API docs by stealth

A few weeks back, I joined Upwork which is a platform for freelancers looking for remote work. The amount of work available is staggering. Although there are many individuals asking for a tech writer to “help make my docs pretty” or proofread their dissertations, there are plenty of actual organisations from all around the worldContinue reading “Learning API docs by stealth”

My first pull request

Big day. I just completed my first-ever pull request to the Mautic project. With some help from one of the senior members of the community, I was able to successfully update the README.md file in markdown, and commit.

My first open source contribution

I know that almost a year has passed since my last post. I haven’t had much luck breaking into the world of API docs (yet). I made a small breakthrough this week when Mautic called on me to be involved in a piece of work relating to their REST API docs. Mautic is an openContinue reading “My first open source contribution”

Coffee and dev docs

Today, I had coffee with Amanda, an Auckland-based tech writer who has had some recent practical experience with developer docs. We exchanged messages through the TechCommNZ (Technical Communicators Association of New Zealand) Slack channel this week and made an instant connection. It was a great meeting. Amanda learned how to document REST APIs by gettingContinue reading “Coffee and dev docs”

Diversify or die

I’ve been a tech writer since 2004. In that time, my sole focus has been producing quality docs for technical and non-technical end-users. Things like online help, training guides, standard operating procedures and disaster recovery plans. For most of the past ten years, I’ve been all about help for non-technical users of software. These areContinue reading “Diversify or die”