Google Cloud’s Enhanced Interactive Docs Earn Editors Alternative Award for DX
There are various sides that go into the main API portals and ProgrammableWeb has created a sequence of articles that aid you perceive what finest practices are being utilized by real-world API suppliers. The sequence was kicked off with a complete guidelines of the standards wanted to construct a world-class API developer portal. Subsequent Editors Alternative articles together with this one will present a extra in-depth take a look at how particular person suppliers have executed on the assorted standards.
Google not too long ago introduced a characteristic replace to its Google Cloud Storage documentation; placeholder variables that may be changed throughout the code samples. This new characteristic lets a developer substitute a placeholder variable inside a code pattern with their very own customized variable.
Determine 1 Placeholder variables can help you use customized parameters within the code pattern
This characteristic permits a developer to make use of parameters particular to their very own occasion thereby giving them a greater understanding of how properly the API will meet their wants. It takes the thought of interactive samples one step additional by permitting for almost bespoke code samples.
One other neat characteristic could be seen when a documentation web page has a number of code samples that every have the identical placeholder variable.
Determine 2 Altering the placeholder variable as soon as, will change the variable for all cases throughout multiples samples on a web page
As you possibly can see within the picture above, if you happen to change the variable in a single place, it is going to be changed wherever else it seems on the web page, together with inside different code samples. Not solely is that this a time saver, it ensures consistency for builders after they run the samples.
Google’s use of placeholder variables is a ahead step that helps make its documentation extra related and simpler to grasp for anybody new to its APIs. For that reason, Google has earned a ProgrammableWeb Editor’s Alternative award for Developer Expertise.