本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Julia 语言
- 技术文档工程师：
- mkg33
- 项目名称：
- 科学机器学习的统一文档
- 项目时长：
- 长期投放（5 个月）
Project description
我希望实现 SciML 组织的统一，因为这方面有很大的改进空间，毫无疑问，完成这个项目将立即为 Julia 程序员和 SciML 的活跃贡献者/维护者带来直接好处。散布于 SciML 中的软件包提供了一些非常实用的工具，但总存在这样一种风险：用户无法发现软件包（尤其是新用户），因为用户无法发现软件包并将其应用到当前问题中。
由于这些包的主要目的是覆盖广泛的程序员（初学者和专家等），这很令人失望。为避免上述情况，我提议彻底修改 SciML 文档的头版，并打造一个供用户浏览相关软件包和探索不断发展壮大的生态系统的中心。对于经验丰富的用户，该平台还可作为有价值的参考，帮助他们提高工作效率。
首先，所有单个软件包的现有文档需要就最基本的样式问题（例如拼写、标点、语法等）进行修订。为了确保样式一致性，SciML 需要一个具体的样式指南（在进行回顾性更改和将来参考时不可或缺）。从头开始将会浪费时间。相反，它应该基于现有的 Julia 惯例，并包含针对 SciML 特定问题的新完整内容。
完成风格指南后，我打算在项目的第二阶段修改当前文档。这会使文档看起来更专业、更稳定。我已经创建了几个拉取请求来说明我执行此任务的方法。在此阶段，我还打算设计（并实施）一个高效的引用系统。第一个任务是更新过时的引用页面。
第三阶段是 SciML 路线图的设计，可以说是最重要的阶段，其中强调分散软件包之间的相互作用。两个软件包（相对于问题或代码本身）的凝聚力越强，它们出现在“另请参阅”列表中的时间越紧密。我提议创建两个建议键：一个用于代码相似度，另一个用于问题相似度。这样，与费力浏览各个代码库和文档相比，用户可以更快地找到其他可能有用的软件包。我不想列出软件包之间的所有可能连接，而是重点关注较大的软件包，并尝试以较小的软件包提供其链接（此方法还将扩展到更新教程，其中应指出与其他软件包的关联）。这种方法可以保证“另查看”列表的内容丰富的信息，而不是对软件包组合进行详尽的枚举。