On an API documentation course we ran for a client yesterday, we showed a number of developer documentation websites, including ones from Amazon, Dropbox, Google and Microsoft. One common theme the delegates noticed was these sites contained a in-page table of contents, or a set of related links, on the right hand set of the screen. You will… Read more »
Tag: information design
A technical communication user’s hierarchy of needs
At the TCUK 2015 conference, Rachel Johnston mentioned the idea of a content maturity model. We thought we’d take this idea and ask: Could we develop a model that illustrates a hierarchy of needs for users of technical communication (and in particular, User Assistance)? A model of what? We suggest calling this model a technical communication user’s hierarchy of needs…. Read more »
Squares v circles on screenshots?
We were asked: “Do you know whether it is better to use squares or circles to indicate something on a screen shot? I use circles with thin border & compliment with an arrow. My colleague uses squares & the Subject Matter Expert prefers circles. I was just wondering whether there is a best practice for this or… Read more »
Issues for developers moving from on-premises software to Software as a Service.
On Monday, I spoke at the Visma Developer Days conference in Riga, Latvia, about some issues software companies have to address when migrating from developing on-premises software to Software as a Service. One of the of the biggest changes is that the revenues are spread over the lifetime of customer – they pay on a… Read more »
Topic-based authoring: The undiscovered country
Many software companies, when they start out, provide user documentation as downloadable PDFs or as web pages. As they develop more products and versions, and as they expand into countries that use different English spellings, the amount of documents can grow until it becomes hard to keep all of these documents up to date. It’s at… Read more »