Design patterns are common themes in the way something is designed. In looking over the many API doc sites, I tried to find some common design patterns in the way the content was published. I already mentioned the division between guides, tutorials, and reference documentation. Here I want to explore more design-specific elements in API doc sites.
Here are several design patterns with API doc sites:
I’ll explore each of these elements in depth in upcoming pages.
Here are some non-patterns. By this, I mean these are elements that aren’t as common in API doc sites:
By non-patterns, it’s not to say these elements aren’t a good idea. But generally they aren’t emphasized in many of the API doc sites.
Get new posts delivered straight to your inbox.
© 2017, Tom Johnson