News for hackers. Stuff that matters.
Re:On Apple's Piss-Poor Documentation by ProAm on Tuesday November 10, 2020 @12:15PM (#25048323)
> So instead you end up on 3rd party tutorials...How do you know if the feature changed significantly in the more recent release? I don’t know, but I can tell you where you won’t find out: the official docs.

Get ready for documentation subscriptions. I wish I were joking.

Re:On Apple's Piss-Poor Documentation by Ronsenshi on Tuesday November 10, 2020 @12:40PM (#25048632)
Already a thing:

https://apps.apple.com/us/app/a-companion-for-swiftui/id1485...

No affiliation. It's sad and a bit pathetic that trillion dollar company can't hire even one person to work on public documentation.

Re:On Apple's Piss-Poor Documentation by alblue on Tuesday November 10, 2020 @08:26PM (#25054529)
They actually have a department to write the documentation. The problem is that it’s a separate department from the people who design the libraries themselves, which means instead of having high quality documentation throughout, you only get the documentation that the doc team had time to write. It’s why most of the APIs are minimal at best in terms of documents.

While the level of documentation that exists is usually pretty good, the sad fact is that most documentation doesn’t exist, and it’s entirely due to the fact that they are handled by developers/documentors separately. If you had developers documenting in-situ in the code, instead of WWDC slides, then it would be a lot better.

Re:On Apple's Piss-Poor Documentation by doyouevensunbro on Tuesday November 10, 2020 @12:56PM (#25048845)
It’s because engineers don’t want to write documentation, and if you don’t force it this is the result.
Re:On Apple's Piss-Poor Documentation by dgritsko on Tuesday November 10, 2020 @03:35PM (#25051541)
I don't think this truism actually holds weight. Some engineers don't want to write documentation, sure. Maybe even most don't - but some actually do enjoy the process of writing good documentation, and they find satisfaction in creating knowledge artifacts that make their code easy to understand and use. It's not enough to just find these engineers, however - they need organizational support so that they have the right tools to create and share good documentation, and are appropriately encouraged to do so.
Re:On Apple's Piss-Poor Documentation by piva00 on Tuesday November 10, 2020 @01:01PM (#25048915)
A trillion dollar company should be able to hire some technical writers to embed into teams and write documentation as part of the process. It's just a lack of care when you have that amount of money.
Re:On Apple's Piss-Poor Documentation by ethbr0 on Tuesday November 10, 2020 @01:38PM (#25049420)
Just hire Microsoft's people. Not even joking.

https://docs.microsoft.com/en-us/dotnet/api/system.string.su...

Re:On Apple's Piss-Poor Documentation by markdoubleyou on Tuesday November 10, 2020 @05:42PM (#25053067)
For Microsoft it depends on when the docs were written.

The MS docs from the late '90s through about 2015 were stellar. For example, look at the Windows Sockets docs[1], which came out of that era. Here you see information architects working at the height of their power: Content is broken up into conceptual ("About Winsock"), task-based ("Using Winsock"), and reference ("Winsock Reference") topics. They were doing this kind of structured documentation before DITA was a thing. It's a pain in the ass to produce content this way, but the results are wonderful.

Then came .NET Core: a fast-moving, community-driven effort, where the philosophy seems to be to get it working and then scribble down some docs later. The result tends to be a huge wall of text with conceptual and sample topics jammed together ([2]), and you're lucky if the API reference gives you anything beyond parameter names.

Azure docs suffer from a different problem. It seems they've tried to apply some kind of rough information architecture, but the quality isn't great. I've looked at the GitHub history of some of the shoddier topics, and they're often written by junior Product Managers who are fresh out of college. I encounter a lot of imprecise, colloquial English describing out-of-date screenshots.

I don't mean to belittle the people who work on .NET Core and Azure. There's a ton of content that needs to be written for these products, and it's a thankless task for the devs & PMs who do the heavy lifting now. I'd really like to see some dedicated technical writers come in and bring the quality back up to their old standards.

[1] https://docs.microsoft.com/en-us/windows/win32/winsock/windo... [2] https://docs.microsoft.com/en-us/aspnet/core/fundamentals/ro...

Re:On Apple's Piss-Poor Documentation by tasogare on Tuesday November 10, 2020 @11:44PM (#25055558)
I use C# daily and most of the time the doc is fine. I agree that sometimes dotnet core docs are a bit messy and frustrating, but still quite good and useful.
Re:On Apple's Piss-Poor Documentation by jjkaczor on Tuesday November 10, 2020 @02:08PM (#25050061)
For all the crap that Apple, Java and other open-source people have piled on Microsoft over the years, their developer documentation has always been very good. Yes, there are rough-edges.

Back in the day, when Sun was still in-charge of Java, I had my 1-person consulting company partner with Sun and become an official "Certified Java" organization... Great, I thought - now I can get some better documentation...

Sure, Sun replied - but first you have to buy a $30,000 server... Thankfully, .NET hit public beta about then and I have never looked back.

Re:On Apple's Piss-Poor Documentation by sirmarksalot on Tuesday November 10, 2020 @04:32PM (#25052260)
I wouldn't say it's always been very good. How well do you remember MSDN? In the mid-2000s, Microsoft documentation lived on three or four separate sites, and I don't remember the names of all of them. The two that spring immediately to mind are MSDN and TechNet. MSDN had the infuriating issue of broken links. You'd be deep-diving on an issue, find a link to an article that looked like it might perfectly address your question, and... 404.

It got so bad that a VP ended up making a pronouncement, declaring a war on broken links. He announced a multi-year plan to reduce and eventually fix all the broken links on MSDN. This was the vacuum that was partially responsible for the birth of Stack Overflow.

Re:On Apple's Piss-Poor Documentation by teh_klev on Tuesday November 10, 2020 @08:49PM (#25054687)
> It got so bad that a VP ended up making a pronouncement, declaring a war on broken links.

Probably Scott Guthrie initiated that. As some nobody I once emailed him directly because I'd discovered a bug in some framework thing with a reproducible example. He actually replied and cc'd in the relevant people at MS and after a short while there was a workaround and a fix and a KB article or something (it's so long ago I barely remember). Impressed? absolutely. MS still have some pretty good and accessible folks, and I'm a huge fan of Scott Hanselman who's a great brand ambassador for DevDiv (and not beyond a few self-deprecating MS jokes about the company's past).

Re:On Apple's Piss-Poor Documentation by bhrgunatha on Tuesday November 10, 2020 @11:55PM (#25055611)
They also suffered the same problem mentioned in this post.

Documentation pages that showed a method's signature with no explanation of the function or example usage. So many times I'd look something up only to find the method name parroted as a full sentence; and those method names were often obscure to the point of meaninglessness.

Re:On Apple's Piss-Poor Documentation by int_19h on Saturday November 14, 2020 @11:29PM (#25098260)
In late-90s to mid-00, if you did any serious Win32 or .NET development, you had the MSDN Library installed locally - it had its own help browser, with integrated search and index. The latter was especially useful, since it contained all structs, classes, interfaces, functions etc, across all platforms for which docs were installed.

Anything that was available online, official or not, was inferior to that. I'm not sure if it was deliberate, but it significantly hampered the utility of pirated copies of Visual Studio - since MSDN docs would require a lot more CDs than the software, most warez releases stripped them out. And in the developing world, where such pirated software is readily available on physical CDs sold by street vendors, they would usually be priced per CD regardless of what's on it - so a complete VS+MSDN bundle would be a lot more expensive, and thus in relatively low demand, and not widely sold.

Re:On Apple's Piss-Poor Documentation by jjkaczor on Thursday November 12, 2020 @09:58AM (#25070529)
Heh... well, I am old enough to remember the offline MSDN - which was great, and the rough transition to online - which got better, eventually... (and the rise of StackOverflow makes more sense in that context) but then at the beginning of the "cloud-era", IMO, it got worse again - to the point that I was constantly complaining about blog articles by MSFT employee's that really should have been folded into the actual documentation/KB instead...

It's a hard sell to tell an IT decision-maker in a different team/group that you need to configure things "just so" (think TechNet versus MSDN for configuration/operational articles) when all you have to point them too is a non-official blog post...

(Don't even get me started about the quality/out-of-date materials for things like Dynamics 365...)

Re:On Apple's Piss-Poor Documentation by wlesieutre on Tuesday November 10, 2020 @02:54PM (#25050900)
There's an old saying at Microsoft: developers, developers, developers, developers, developers, developers, developers, developers
Re:On Apple's Piss-Poor Documentation by ethbr0 on Tuesday November 10, 2020 @03:17PM (#25051281)
It's mocked, but the underlying observation is astute.

In the personal computing world, first parties can't build enough user software.

Furthermore, software availability and reliability lag third party developer and development ecosystem health. A bad experience doesn't hurt the platform today, it hurts the platform in 1+ years.

And perhaps even worse, steps to address it take effect over a 1+ year timeframe as well.

Apple's been able to leverage iOS market share into papering over the desktop reality, but they're going to find the emperor has no clothes real quickly if anything about that calculus shifts in a bad way.

Re:On Apple's Piss-Poor Documentation by int_19h on Saturday November 14, 2020 @11:34PM (#25098278)
If you recall, back when the first iPhone came out, the idea was that Apple itself would be the only provider of first-class software for it, and everything else was relegated to web apps.

It didn't work out for them back then, and so we got native apps and the store. But I can't help but think that Apple still sees it as a sort of compromise of their ideal vision of what the platform should really be like, and thus dev ecosystem evolution is mostly on the backburner. Just look at how long it took for Swift to appear, despite Obj-C being really dated by that time.

Re:On Apple's Piss-Poor Documentation by jonhendry18 on Tuesday November 10, 2020 @04:32PM (#25052255)
Apple used to be better about developers, I think, back 2000-2010 or so.
Re:On Apple's Piss-Poor Documentation by wlesieutre on Tuesday November 10, 2020 @04:46PM (#25052415)
Mocked at the time, but looking back it sounds pretty good. Maybe Apple needs a Steve Ballmer.
Re:On Apple's Piss-Poor Documentation by Spivak on Tuesday November 10, 2020 @01:40PM (#25049442)
It's not really the size of the company. Anyone qualified to write good documentation can make better money, work on more interesting things, and advance their career by actually working on the code. Without a culture that rewards and values the work it doesn't get done.
Re:On Apple's Piss-Poor Documentation by chipotle_coyote on Tuesday November 10, 2020 @01:59PM (#25049873)
Well, not everyone who is qualified to write good documentation wants to work on the code, nor would they necessarily be as good at writing code as they are at writing documentation. If you're writing API documentation, you need to be enough of a coder to understand what the engineers are talking about -- and what they aren't talking about but really should be! -- but that doesn't mean you need to be coding at a level where you could have a career writing apps built on that API, let alone coding at a level where you could have a career implementing the API itself.

It's the "culture that rewards and values the work" that's really the issue, I suspect. Apple certainly used to have a culture of good documentation, and I know they've hired good writers, technical and otherwise, over the years. It's actually kind of difficult to explain why their docs are the way they are, other than just not putting any real priority on the necessary work.

Re:On Apple's Piss-Poor Documentation by jyounker on Thursday November 12, 2020 @02:31PM (#25073866)
This. Developers aren't getting credited or promoted for writing documentation, or assisting in the process.
Re:On Apple's Piss-Poor Documentation by jonhendry18 on Tuesday November 10, 2020 @04:30PM (#25052238)
You have to give them time to write it, too.
Re:On Apple's Piss-Poor Documentation by RockmanZero on Tuesday November 10, 2020 @06:21PM (#25053446)
wrong! bad engineers don’t want to write documentation
Re:On Apple's Piss-Poor Documentation by SilasX on Tuesday November 10, 2020 @01:17PM (#25049139)
Reminds me -- it used to be that I could plug my Macbook air into a monitor and arrange my windows, and it would return them to that position whenever I'd disconnect and come back. That feature vanished as of ~2018 and you have to buy some app to get it back.
Re:On Apple's Piss-Poor Documentation by tidbits on Tuesday November 10, 2020 @01:49PM (#25049583)
My Macbook pro still does this. Granted, it's a little wonky. If you alter the window in any way while disconnected then it might not return to the original location. It also doesn't preserve any new desktop environments created on the external display.
Re:On Apple's Piss-Poor Documentation by jonhendry18 on Tuesday November 10, 2020 @04:33PM (#25052276)
>Get ready for documentation subscriptions. I wish I were joking

I thought that was what the $99/year was for.

Re:On Apple's Piss-Poor Documentation by mrtksn on Tuesday November 10, 2020 @12:34PM (#25048551)
That actually sounds good. When you pay for something it implies that you might stop paying for the thing if you’re not happy which means the seller is likely to work hard to make you happy.

I would love to have paid version of most of the apps/sites I use. Not ad-free subscription but paid version where I can be the unhappy customer when I am unhappy.

Re:On Apple's Piss-Poor Documentation by grp000 on Tuesday November 10, 2020 @12:45PM (#25048683)
That would make sense if documentation were a standalone product, but it's completely complementary to the language, so that doesn't make any sense.
Re:On Apple's Piss-Poor Documentation by munificent on Tuesday November 10, 2020 @12:46PM (#25048711)
> Get ready for documentation subscriptions.

MSDN Library. Everything old is new again.

Re:On Apple's Piss-Poor Documentation by qayxc on Tuesday November 10, 2020 @01:11PM (#25049040)
That's a bogus claim! The MSDN documentation has always been freely available. The subscription service included all of Microsoft's software editions for development purposes and that's what subscribers actually paid for.

The documentation of software packages, APIs, and driver kits was freely available online.

Re:On Apple's Piss-Poor Documentation by dragonwriter on Tuesday November 10, 2020 @01:17PM (#25049140)
> The MSDN documentation has always been freely available

No, it hasn't. It was originally available exclusively to subscribers, and only on CD. MSDN started before the web existed.

Eventually, the documentation became free on the web.

Re:On Apple's Piss-Poor Documentation by qayxc on Tuesday November 10, 2020 @04:58PM (#25052567)
> It was originally available exclusively to subscribers

No it wasn't - the subscription service shipped CDs (and later DVDs) with technical articles, updated SDKs and the like. The actual documentation was always included with every Visual Studio version on the installation discs.

I remember quite vividly the "joy" of re-installing the latest version because the documentation format was incompatible between releases and you could either reinstall the new version from disc (which took ages) or convert the already installed one (which also took ages, but not quite as long as juggling 4 CDs - it had to "rebuild the index" or some nonsense like that IIRC).

So if you owned a physical copy of any Visual Studio edition, you also had the documentation and thus no need to subscribe to MSDN (apart from the technical columns, SDK updates and the magazine, which any reasonable boss would allow you to read during work hours).

Re:On Apple's Piss-Poor Documentation by throwaways885 on Tuesday November 10, 2020 @01:33PM (#25049351)
That's a bit unfair. The web is what made it easy to publish at no cost, CD's still had mail and print costs associated so it made sense to send documentation with the software packages it... documented.
Re:On Apple's Piss-Poor Documentation by dragonwriter on Tuesday November 10, 2020 @02:20PM (#25050338)
What's unfair? It's an accurate actual description with no value judgement.

You seem to be arguing against a negative value judgement which I did not make, or even suggest.

Re:On Apple's Piss-Poor Documentation by bluGill on Tuesday November 10, 2020 @03:13PM (#25051223)
Perhaps, but they didn't charge $3 for the CD, which is about the incremental cost of making a copy and mailing it out would be.