Future Documentation
Dotan was digging through vendor supplied documentation to understand how to use an API. To his delight, he found a specific function which solved exactly the problem he had, complete with examples of how it was to be used. Fantastic!
He copied one of the examples, and hit compile, and reviewed the list of errors. Mostly, the errors were around "the function you're calling doesn't exist". He went back to the documentation, checked it, went back to the code, didn't find any mistakes, and scratched his head.
Now, it's worth noting the route Dotan took to find the function. He navigated there from a different documentation page, which sent him to an anchor in the middle of a larger documentation page- vendorsite.com/docs/product/specific-api#specific-function.
This meant that as the page loaded, his browser scrolled directly down to the specific-function section of the page. Thus, Dotan missed the gigantic banner at the top of the page for that API, which said this:
/!\ NOTE /!\ NOTE /!\ NOTE /!\ NOTE /!\ NOTE /!\ NOTE /!\ NOTE /!
This doc was written to help flesh out a user API. The features described here are all hypothetical and do not actually exist yet, don't assume anything you see on this page works in any version
/!\ NOTE /!\ NOTE /!\ NOTE /!\ NOTE /!\ NOTE /!\ NOTE /!\ NOTE /!\
On one hand, I think providing this kind of documentation is invaluable, both to your end users and for your own development team. It's a great roadmap, a "documentation driven development" process. And I can see that they made an attempt to be extremely clear about it being incomplete and unimplemented- but they didn't think about how people actually used their documentation site. A banner at the top of the page only works if you read the page from top to bottom, but documentation pages you will frequently skip to specific sections of the page.
But there was a deeper issue with the way this particular approach was executed: while the page announced that one shouldn't assume anything works, many of the functions on the page did work. Many did not. There was no rhyme or reason, to version information or other indicators to help a developer understand what was and was not actually implemented.
So while the idea of a documentation-oriented roadmap specifying features that are coming is good, the execution here verged into WTF territory. It was a roadmap, but with all the landmarks erased, so you had no idea where you actually were along the length of that road. And the one warning sign that would help you was hidden behind a bush.
Dotan asks: "WTF is that page doing on the official documentation wiki?"
And I'd say, I understand why it's there, but boy it should have been more clear about what it actually was.
Iskra Lawrence claims she was dropped from her first modelling agency aged 15 for getting 'too curvy'
The meaning behind Strictly Come Dancing's 'vulnerable four' - and why the 'terrified' stars shouldn't panic
Supermicro admits building AI infrastructure is a tricky, low-margin business ... for now
Server-maker and designer Supermicro has promised to improve performance, after missing its guided revenue and revealing its margins aren’t strong.…
Woman has licence revoked after drinking and driving BMW down Kelvedon High Street
Thousands of new homes allocated as Braintree District's Local Plan takes shape
Essex doctors surgery to expand due to growing patient demand
Kieran Culkin and wife welcome third child after Oscars 'pact' to keep growing their family
AMD Is Coiled To Hockey Stick In The AI Datacenter
If all goes according to the high end of plan, then AMD should kiss $10 billion in revenues in the fourth quarter of this year, and if it was low-balling that number a little, then it should break through $10 billion and put the wrap on a $34.3 billion year that was its best year ever and its most profitable one in terms of absolute dollars and one of its better ones for net income as a share of revenue. …
AMD Is Coiled To Hockey Stick In The AI Datacenter was written by Timothy Prickett Morgan at The Next Platform.
Boy, 15, stabbed to death as 100 teens descend on New York home in house party mayhem
Tanzania back online after politically motivated five-day outage
The African nation of Tanzania has reconnected to the internet after a five day outage.…
Leonardo DiCaprio continues environmental efforts ahead of COP30 global climate summit in Brazil
Bombshell update in the hunt for missing toddler Gus Lamont - as cops reveal latest new move
Buckle up Blake! Justin Baldoni reveals It Ends with US court battle is far from over
Google's New Hurricane Model Was Breathtakingly Good This Season
Read more of this story at Slashdot.