文档:为 Joomla 做贡献的绝佳方式
有句明智的话曾说:“软件的质量取决于其文档的质量”。好吧,我只是随便编的,但这句话很可能出自一位智者之口,因为它很有道理。Joomla 在文档方面的情况如何?你如何帮助 Joomla 获得应得的文档?我们采访了 Joomla 文档团队的负责人 Dieter Ziller。
Dieter,你们团队肩负着重要的任务!你能向我们解释一下文档团队的工作吗?
根据定义,Jdocs 团队负责创建和维护官方 Joomla 文档,包括翻译。这意味着我们不仅要负责面向最终用户的文档,还要负责面向核心开发者、扩展开发者、网站管理员和网页设计师的文档。我们还预计要维护帮助页面,这些页面可在每个 Joomla 安装中找到,以及 API 文档,这更像是一个参考列表。
所以实际上你们构成了 Joomla 的知识库。我们有哪些类型的文档,是否都属于你们的团队?
知识库是一个很大的概念,Joomla 应该有一个很棒的知识库。目前我们有一个用于用户文档的 wiki,里面有很多过时内容,组织也比较混乱;自 2022 年中以来,还有一个新的开发者手册(https://manual.joomla.net.cn/docs/),这对于核心和扩展开发者来说是一个越来越有价值的信源。它由 CMS 维护者维护,尤其是 Harald Leithner。
团队目前面临的主要挑战是什么?
从哪里开始,在哪里结束?多年的“粗心”维护最终会带来影响。
历史上,维基原本旨在涵盖所有与Joomla CMS相关的主题。当维基创建时,WikiMedia软件为多语言知识库提供了一个良好的基础。大量志愿者维护了内容。现在情况已不再是这样。
最古老的文章可以追溯到2008年(如果我的研究正确的话),并且仍然可用。搜索功能无法过滤文章的年龄,因此您可能会得到一篇为Joomla 2.5编写的文章。没有明确的概念允许新用户逻辑地探索文档的内容。此外,WikiMedia仍然是一款优秀的软件,但可能不再是我们的首选。
那么Joomla维基就注定要失败了吗?
关于替代平台的首次请求是在两年多前提出的。除了其他现成的解决方案外,还在讨论基于Joomla的解决方案。Cliff Ford为Joomla开发了一个组件,并在之前的JCM文章中提出了他的想法。他投入了大量精力,使现有的维基文章可用于他的基于Joomla的Jdocmanual(《[链接](https://magazine.joomla.net.cn/all-issues/october/joomla-documentation-a-joomla-solution)》)。这将向所有批评者证明,Joomla作为一个CMS能够管理甚至最大的网站。如果我们能说:“Joomla文档由Joomla CMS提供支持”,这对Joomla的形象将产生巨大的好处。
维基将作为Jdocs存在,直到找到替代品。届时,所有与Joomla 4及以后版本相关的相关现有文档都需要导入。
要取得成功需要什么?
我们应该尽快成立一个工作组,定义下一版本的必要条件,为董事局准备提案,并为2025年Google文档季节准备申请。这是我们未来几个月的主要任务。悬而未决的游戏——维基是否会留下——接下来是什么——所有这些都造成了大量的不确定性,需要尽快解决。如果有人有兴趣成为工作组的一员,请尽快直接在Mattermost上联系我。
您如何知道需要哪些文档?
理想情况下,我会从开发团队那里得知,或者跟踪GitHub上CMS存储库的拉取请求。在Mattermost上,除了官方的文档频道外,我们还有一个用于文档建议的频道,最后是文档伙伴频道,Phil在他的JCM文章中对其进行了更详细的描述(《[链接](https://magazine.joomla.net.cn/all-issues/november-2022/document-buddies-making-joomla-better-without-writing-a-line-of-code)》)。
团队是如何工作的?你们有会议吗?有Mattermost频道吗?你们使用什么工具?
团队成员主要独立工作,并自行决定。目前,活跃成员如此之少,以至于只需通过Mattermost频道(在Joomla的Mattermost实例中搜索PD Documentation)分享信息就足够了。如果我们能吸引更多贡献者,我可以想象再次定期进行视频会议。如果这是获得计划工作组更好成果的唯一方法,可能还需要进行文档冲刺。目前我们只是在使用我们拥有的工具,例如内部维基工具和GitHub以及Google提供的工具。但我对新建议持开放态度。
我明白你们正在寻找志愿者。你们在寻找什么样的人?任何人都可以加入吗?还是需要超级技术型人才?
我说我们接受任何愿意帮忙的人——但这只是半个真相。有些Joomla经验会有帮助,但不是必需的。毕竟,我们还想让用户文档对新手友好。对经验丰富的用户或程序员来说,很难设身处地考虑新手的感受。他们常常忘记提及那些经验丰富的用户需要掌握的中间步骤,这些步骤会使新手感到绝望。对我来说,更重要的是写作的愿望和热情。我希望这个声明能鼓励一些潜在的新作者或翻译者与Mattermost上的JDocs团队取得联系。
对团队成员有什么期望?
同理心和真诚地愿意帮助他人。Joomla在全球范围内被使用。我们向具有广泛经验的各种人群提供我们的CMS。尊重我们文档的接收者必须是我们首要任务。这必须反映在文档的每一句话中。
关于Joomla文档,最常见的误解是什么?
我自己在开始时就遇到了误解:我也想知道我非常有限的知识是否足够理解PHP代码、SQL数据库和CSS指令如何结合在一起形成一个HTML页面,并展示既具有信息性又具有视觉吸引力的页面。我能否与那些每天像魔术一样编排代码片段的人竞争?
然而,用户文档是为那些想学习东西的人写的,而不是为那些已经知道东西的人写的。它应该用读者能理解的语言来写。
这意味着你不必是超级程序员(这有时可能是一个缺点)就能编写教程或手册。
所以,朋友们,即使你不知道如何编写代码,也不要害怕联系Joomla。看看“需要帮助”下的志愿者门户,看看你感兴趣的任务,不要害怕联系团队领导。志愿者不仅需要编写文档。我相信营销、社交媒体和网站团队也会欢迎任何愿意并能够帮助的人。
如果我无法定期贡献,我可以在必要时帮忙,例如在PBF活动期间吗?
没有人期望每天/每周/每月创建一定数量的页面,或者至少x小时。如果一个用户偶然发现一个错别字或其他错误并进行了纠正,或者因为时间或知识不足而报告了问题,那么这对我来说就像写一整页一样有价值。PBF活动是一个在友好环境中结识新朋友的机会,无论是面对面还是虚拟的。有这么多用户在场上,尝试新事物非常容易,因为你可以直接得到问题的帮助。
我们还能以其他方式提供帮助吗?
如前所述,我们的维基运行在MediaWiki软件上。最近,由于志愿者数量的波动,出现了这种情况:团队中没有人在管理MediaWiki服务器方面有太多经验,或者总是因工作或个人原因而可用。因此,我们急需寻找有大型MediaWiki安装经验的某人,以协助我们的管理员。
还有其他什么事情让你感到亲近吗?
我应该为此感到高兴——但目前的状况令人沮丧。Jdocs上的注册人数在不断增加。仅在过去12个月内,就有超过900人创建了新账户。毫无疑问,有些人创建了假账户。
由于脚本和维护以及维基媒体扩展控制的缺失,下一个应该运行的过程已损坏。目前我看到用户XYZ已经注册。然而,除非他们确认了他们的电子邮件地址,否则我无法联系到这位用户。用户列表还显示新用户是否已经创建了他们的个人资料页面。这可以是一条简短的、可以快速创建的行。
由于我必须手动通过列表,这对我欢迎新助手和在他们需要时提供支持非常有帮助。
因此,如果您在注册后没有收到我们的回复,请通过志愿者门户联系我!
在Joomla社区杂志上发表的一些文章代表了作者在特定主题上的个人观点或经验,可能并不符合Joomla项目的官方立场
通过接受您将访问https://magazine.joomla.net.cn/之外的第三方外部服务
评论