就像WWDC即将开始一样,Michael Tsai发布了一篇简短的注意,其中详细说明了如何下载和访问Apple的旧概念文件,其中大部分时间从未在过去五年或以上更换或更新。通过一个奇怪的巧合,这是WWDC在WWDC中没有少于五个视频,关于一个名为DOCC的新开发人员文档系统,这对于许多评论员似乎已经过了不受伤的。然而,两者都是WWDC的大象的明显迹象:文件。
曾几何时,Apple及其Macintosh计算机以与Addison-Wesley的合作发布的印刷书籍内部的Macintosh系列的形式具有示例性文档。这些卓越的卷是由技术作者撰写的与苹果工程师密切合作,仍然是许多书架。
到Mac OS X出现的时候,印刷书籍不再似乎是Apple快速发展的操作系统的最佳平台,并且制作了大量概念导游和手册,并可自由制作。如果您遵循Michael Tsai的说明,那么这些仍然可以使用,但大多数尚未更新,即使在与最近的来源结合使用时,他们的实用性现在有限。
第三方尝试记录Mac OS X的勇敢,但没有任何一定的变化步伐。 Amit Singh的Mac OS X Internals于2006年由Jonathan Levin的优秀Trilogy * OS内部替换为2017年左右,只能通过缺乏指数来损坏。但莱文迟早没有完成他的系列,而不是抛弃它,以便对Android进行记录。
Docc看起来很令人兴奋,并且展示Apple至少部分地认识到其问题。但它落入了几个着名的陷阱。
首先,它专注于单个函数在API内的记录呼叫。对于已经理解该子系统在麦斯科斯队的工作原理的开发者,这是必不可少的。但是,尝试通过参考API中的各个函数来尝试Grok Propplic Topics。首先需要围绕子系统设计和功能,苹果曾经如此擅长的概念性的概念性。正如Apple很好地知道,良好的概念文档都是与API的课程和函数不同的结构和写入。
DOCC是最近的长线方案,以“自动”创建代码和文档。第一个我可以记住跨越的是唐诺克的识字编程,从1984年开始,它在Wikipedia的一篇优秀的文章中讨论了,这也列出了使用标记文本来记录Swift代码的现有能力,通过埃里卡的精细书的主题。萨通。没有系统是“自动”当然:没有逃避某人必须编写代码的事实以及某人的文件,无论它们如何纠缠在一起。
与几乎所有其他的倡议都很常见,这种方法假定是文档摩托斯的最佳人士是其工程师。这些工程师经常在面试中选择一个编码挑战,但您有没有听说过由或他们记录代码的能力选择软件工程帖子的候选人?
虽然许多苹果的工程师都是 - 当他们被赋予时间和机会时 - 优秀在文件中,但很多都没有。这不是为什么他们代码,也不是写得良好的文档的技能,甚至类似于编写良好代码的文件。并且在易于解释的情况下,麦斯科斯州内部系统的概念,我怀疑在任务中闪耀的工程师数量很小。
近年来,在没有任何更好的东西的情况下,大多数开发商都依靠介绍,他们的成绩单和支持WWDC的材料。在某些区域,这基本上是我们分开的唯一文档,我们与API中的各个函数账户分开。他们的覆盖范围是拼凑而成的,并且可能不会涵盖重要的主题几年。例如,自2016年在WWDC介绍以来,只有三个半小时课程覆盖APFS。
APFS是强制文档失败的另一个例子。比较Apple平台安全指南中的安全系统的流利账户,这是一个非常少数概念性指南,它保持在Apple之前的高标准,并且在其参考中的巨大复杂APFS的概念指南之一,这尚未更新或延长一年。
但是,DOCC和以前的文档方案是绝大陆目标,旨在开发人员,并将高级用户留下要覆盖的子系统的要点。他们省略了巨大的麦克斯,不打算被第三方访问,苹果通常试图在私人框架和封闭来源的应用中挖掘。参加时间机器,唯一的文件是针对相对新手的。它占据了已故的詹姆斯池塘(1943-2013),探索和编译了时间机器的高级细节。
这是在DOCC上的苛刻,这是非常值得称道的,每个开发人员都应该观看致力于它的五个视频。但是,这篇文档饥荒只能在苹果中恶化,我真的无法看到DOCC证明一个解决方案。我有许多用户报告说,当他们将麦克斯问题带到Apple支持时,他们处理了比用户更少的文档的Apple工作人员。
Apple自己的工程师似乎也需要。我收集了世界上最大的顾客关于摩托斯技术方面的第三方书籍,包括三卷Jonathan Levin的系列,是Apple。
Docc实际上是一个悲伤的帮助。 团队仍在努力填补打呵欠的鸿沟:具有讽刺意味的是,我在很长一段时间内读过的最佳新手页之一是,对于Butil,除了通过实验之外不应使用Apple的命令工具。 但是,那些是例外,而且每种情况都有几十个人页面尚未更新,而现在不符合他们的使用信息。 两次失败仍然是Apple及其惊人的产品:错误和文档。 没有平衡两者和改变的课程,他们只能变得更糟。 发布在Mac,技术和标记的Apple,Docc,文档,Macos 12,Montey。 书签永久链接。