这是午餐楼的后续会议在向后兼容会话上。
日期:2023年8月23日
与会者:@埃拉特里克斯 @mcsf公司 @自我 @阴毛 @伯恩哈特-雷特 @蒂莫西布林贾科布斯 @约宾 @普里索尔 @安娜扎祖 @richtabor公司 @吉奥罗牌手表。每个人都同意在这里列出,因为这是一次临时会议。
笔记
现场指南历史
大约3.2-3.3,有一份关于Nacin向后兼容性的现场指南。关于RC1,发送电子邮件至插件 插件是一个包含一组功能的软件,可以添加到WordPress网站。他们可以扩展功能或为WordPress网站添加新功能。WordPress插件是用PHP编程语言编写的,并与WordPres无缝集成。这些可以在WordPress.org插件目录中免费https://wordpress.org/插件/或者可以是来自第三方的基于成本的插件开发人员来了,创建的电子邮件对于电子邮件来说太多了,导致在Make上发布了一篇帖子。在受到社区的欢迎后,这一过程演变成了现场指南过程。此后,每一个版本的长度都在增长。当进行视觉比较时,现在仅仅为了浏览,它的长度是原来的6倍,这使得扫描变得更加困难。
构建对话的问题
以下问题用于指导和构建对话:
- 如何通过重新格式化Field Guide的内容来改进开发人员的信息传递?
- Make博客是人们参与该资源的正确渠道吗?
开发者博客讨论
开发人员博客相对较新,现在社区中的任何人都可以为其贡献自己的力量。它是一个由少数人组成的团体,目前还有每月一次的“新增内容”汇总,可以扩展和构建。开发人员博客的最初想法是消除噪音,并为扩展器提供有价值的资源。这就为那些制作WordPress出版社。目前开发博客有更多的流程,这可能会让坚持下去变得更加困难。
信息传播
当谷歌搜索功能或更新时,会有一种令人困惑的体验,即出现的内容可能是4-5年前的内容,而不是链接到文档。这是因为Make上共享了帖子核心 核心是运行WordPress所需的一组软件。核心开发团队构建WordPress。然后开始链接和共享,导致该帖子的权重上升,谷歌受到的第一个冲击是一个开发注释,而不是文档。在更新文档以链接到文档之后,我们可能需要返回到开发注释,以将人们重定向到最新版本。
具体到开发注释,还有一个问题是,开发注释是一种文档形式,它代替了文档,而不是“这里有什么问题”。现在,开发注释既充当文档,又基本上破坏了更改。
如果你再往前看块 块是一个抽象术语,用于描述使用WordPress编辑器组合在一起形成网页内容或布局的标记单元。这个想法结合了过去可能通过短代码、自定义HTML实现的概念,并将发现嵌入到单一一致的API和用户体验中。编辑手册文档,其中包含大量内容。目前正在进行工作,以确保学习/教程进入学习WP,文档仍保留在文档中。一般来说,文档分散在官方博客帖子、非官方博客帖文、开发笔记、开发手册、面向用户的文档等中。它在这么多地方并不一定很糟糕,但事情是朝着正确的方向发展还是被遗漏了?这甚至可以归结为基本的格式更改,例如将内容标记为“破坏性更改”,或为破坏性/高影响更改设置专门的部分。现在,它是按组件而不是按《现场指南》的优先级进行细分的。
内容重新格式化
当考虑现场指南的格式和方法时,当考虑使用现场指南的人的角色时,会抛出以下问题:有大的吗用户界面 UI是用户界面的缩写,即用户与之交互的页面布局。想想“他们是怎么做到的”,少想想他们在做什么。更改以通知客户或更新周围的插件?有没有可能会破裂的东西,我需要做些什么?这次发布的主要内容是什么?我在哪里可以获得更多信息?这导致了两个具有不同方法的现场指南的想法:
- 一个高度集中的版本,包含更多精心策划的信息。
- 更长、更健壮的版本。
现在,分离出一个经过精心策划的来源需要一定的专业知识水平,以确定项目中最相关但并不普遍的内容。
从扩展器获得早期反馈的难点
我们讨论了发布前的一般流程,以及让人们进行测试、提供反馈等,作为共享开发说明的更广泛流程的一部分。在发布之前,有alpha/贝塔 一种预先发布的软件,分发给大量用户在真实条件下进行试用。Beta版已经在内部进行了alpha测试,在外观、感觉和功能上与最终产品相当接近;然而,设计更改经常作为过程的一部分发生。论坛,你可以得到一些反馈,但它往往不会去任何地方。开发人员更可能使用Trac公司 Trac是贡献者为bug或功能请求创建问题的地方,与GitHub非常相似。https://core.trac.wordpress.org/.和github GitHub是一个提供git存储库在线实现的网站,其他开发人员可以轻松共享、复制和修改这些存储库。公共存储库可以免费托管,私有存储库需要付费订阅。GitHub引入了“拉请求”的概念,在将贡献者在分支中所做的代码更改合并为存储库所有者之前,可以对其进行审查和讨论。https://github.com/所以我们可以把他们更多地指向那个方向以获得反馈。一般来说,让开发人员进行测试或钢筋混凝土 有可能成为最终产品的软件测试版,除非出现重大错误,否则随时可以发布。考试很难。
构建编辑器示例
为了以一个具体的例子作为谈话的基础,我们深入讨论了围绕iframing的工作。对于一些插件,他们没有反应 React是一个JavaScript库,它使推理、构造和维护无状态和有状态用户界面变得容易。https://reactjs.org/.因为他们觉得未来会有一个解决方案来解决问题,而不是采取行动和报告。如果我们不知道反馈,我们就无法做出改变!
WordPress开发者博客将是一个很好的方式来解决iframing等问题,并深入探讨如何克服不同的采用途径。如果用文档支持这项工作,那么它可以很好地涵盖重大的、突破性的主题。
我们就如何在缺乏iframing的情况下使用Site Health来帮助鼓励人们采用它进行了一些探讨。一般来说,对于较大的更改,如iframe公司 iFrame是内联框架的缩写。iFrame用于在网页中加载另一个HTML文档并呈现它。该HTML文档还可能包含JavaScript和/或CSS,在用户浏览器解析iFrame标记时加载。,我们需要将沟通计划视为工作的一部分。对于iframe,每种情况都大不相同,所以很难正确处理。开发商关系部应该能够在这里提供帮助。DevRel在开源 开放源代码是指原始源代码可以免费获得,并且可以重新发布和修改的软件。开放源代码**必须通过许可模式提供,请参阅GPL。因为它通常必须由一家公司赞助,这就带来了围绕放大某些变化的动机的偏见和问题。与此同时,我们需要那些正在进行外联和参与的人。
适应变化的动机
必须考虑的一部分是,销售是为了更新产品,尤其是在没有明显好处的情况下。这可以通过在Site Health中通知用户插件可能没有及时完成工作来衡量。警告有助于鼓励更好的实践,并让人们解决问题。我们越能让它可见,它就越能加强更新。
抑郁策略
贬低的话题出现了:当我们贬低某件事时,它什么时候会被删除?我们应该研究时间框架,以确定如何最好地处理和沟通。这对实施者来说可能很困难,过去情况变化如此之快。当古腾堡 古腾堡项目是WordPress的新编辑器界面。编辑器改进了创建新内容的过程和体验,使编写丰富内容变得更加简单。它使用“块”来增加丰富性,而不是短代码、自定义HTML等。https://wordpress.org/gutenberg网站/这个插件首先问世,它鼓励人们在事情变化如此迅速的时候使用它进行构建。这导致了一些不信任和失望。我们还有来自菲律宾比索 PHP(PHP:Hypertext Preprocessor的递归缩写)是一种广泛使用的开源通用脚本语言,特别适合web开发,可以嵌入到HTML中。http://php.net/manual/en/intro-whatis.php.从0.7.1开始,我们不赞成,但没有删除,所以这是一个更大的问题。在重新关注沟通和现场指南这一主题之前,我们提出了一些不雅观的解决方案。
文档和开发说明
Dev注释通常很难找到,其中一些可以通过以下方式进行改进WordPress.org网站 用户创建和共享WordPress代码的社区站点。您可以在这里下载WordPress核心、插件和主题的源代码,以及社区对话和组织的中心位置。https://wordpress.org/网站重新设计。开发人员注释应提供定期更新和维护的文档。我们讨论了应用程序密码的工作原理,即信息只在开发说明中而不是在文档中,以及这是一个问题。
可以编写文档的人比较有限,但在Make Network上编写文档是相当开放的。对于开发人员来说,只做开发笔记比帮助文档更容易。不过,文档团队应该能够从开发说明中处理这些文档更新。文档团队有一个repo,您可以在其中创建票据,他们可以处理更改,GitHub上处理的块编辑器手册除外。理论上,一个步骤可能只是创建一个GitHub版本的开发注释更改,并更新这些文档。
开发说明的时间表
我们讨论了开发注释是如何要求在特定的时间线之前提交的,但事实上,在整个发布过程中,事情有时会延迟到RC4。同时,开发注释对于注释/反馈和消息传递的迭代非常有用。如果将更新直接转移到文档中,您将错失更好的参与和机会。
接下来的步骤:
- 建议文档主管的职责可能是帮助确保开发注释进入开发文档。
- 在文档更新后更新开发说明,以帮助解决SEO问题。
- 解决开发注释跟踪问题(例子)在GitHub中查看优先顺序/破坏性更改的感觉,并探索在《现场指南》中设置专门的“破坏性更改”部分的想法。
- 探索两个现场指南的想法:一个高度集中的版本,包含更多精心策划的信息,另一个更长、更健壮的版本。
- 做一封类似插件作者的主题作者电子邮件,以传达突破性的更改。
- 重新思考开发笔记,看看自第一次介绍以来,手册中可以发展出什么。
- 为开发注释创建一个模式,以创建更一致性和更易于编写的内容。
- 发布专门的开发人员博客文章,以打破深入到更改中的更改。
#顶峰,#2023年峰会