This is just a quick update to let you know that yes, we know that the Shopify developer documentation needs work. There’s a fair bit of information there, but it could stand some improvement. There’s some missing information, it could be organized better, there are parts of it that are confusing and there need to be examples in languages and frameworks other than Ruby and Rails.
This update is also here to let you know that we’re actively working on it, bit by bit, every day. As I write this, David Underwood and are are working on a wholesale reorganization of the developer sections of the wiki and clear writeups of all the API resources, including explanations of the parameters they expect and the attributes they return as well as how they relate to other resources and what effects they have on shops. We’re also working on more example code, in more languages.
If you’ve got comments, questions and suggestions about the docs or what we’re doing with them, please let us know — feel free to leave a comment or drop me a line.
This article also appears in the Shopify Technology Blog.
When I took this developer evangelism job and returned to the Microsoft platform almost two years ago (after an eight-year hiatus) one of the first things I had to deal with was the sheer size of it. Even people who’ve been working in a certain area of the platform get lost when they venture out to other parts (say, when a desktop developer decides to give web development a try).
If you’re thinking about exploring unfamiliar parts of the Microsoft platform and don’t know where to start, try using one of the Developer Guidance Maps. Like city maps, they give you an at-a-glance view of the “lay of the land” and make certain useful “landmarks” – different types of documentation, key topics on developing for a specific technology and notes on features you need to know about – easy to find.
Built by the people at Microsoft’s Connect Innovation Center, they’re using the Developer Guidance Maps as a way to model, prototype and test ways to find, organize and share guidance for developers in a meaningful way. I find them pretty useful, both for myself as well as places to point developers with questions.
The Developer Guidance Maps break down the platform into a number of subject hubs:
You can also choose to cruise the Developer Guidance Maps by technology:
And you can also go through them via resource type:
Give the Developer Guidance Maps a look!
For more information, see:
This article also appears in Canadian Developer Connection.