本页详细介绍了 Google 文档季收录的技术文案项目。
项目摘要
- 开源组织：
- Julia 语言
- 技术文档工程师：
- mkg33
- 项目名称：
- 科学机器学习的统一文档
- 项目时长：
- 长时间运行（5 个月）
Project description
我想要努力统一 SciML 组织，因为这方面有很大的改进空间，该项目的完成无疑将为 Julia 程序员和 SciML 的积极贡献者/维护者带来直接利益。SciML 中散布着一些非常实用的软件包，但它们很容易被忽略（尤其是新手），原因仅仅在于用户无法发现这些软件包并将其应用于手头的问题。
这令人相当沮丧，因为这些软件包的主要目的是覆盖广大程序员（包括初学者和专家）群体。为避免上述情况，我建议彻底修改 SciML 文档的“首页”，并创建一个用户可以用来浏览相关软件包并探索不断发展的生态系统的枢纽。它还可以为经验丰富的用户提供宝贵的参考信息，让他们更高效地工作。
首先，所有单独软件包的现有文档都需要修改，以解决最基本的样式问题（例如拼写、标点符号、语法等）。为确保样式一致，SciML 需要有具体的样式指南（对于进行回溯性更改和日后参考而言，至关重要）。从头开始会浪费时间。而是应基于现有的 Julia 惯例，并包含针对 SciML 专用问题的新条目。
完成样式指南后，我打算在项目的第二阶段修改当前文档。这会使文档看起来更加专业和稳定。我已经创建了几个拉取请求来说明我完成此任务的方法。在此阶段，我还打算设计（并实现）一个高效的引用系统。第一项任务是更新过时的引用页面。
第三个阶段可以说是最重要的阶段，涉及设计 SciML 路线图，这将强调零散软件包之间的相互作用。两个软件包之间的内聚性（相对于问题或代码本身）越强，它们在“另请参阅”列表中的显示位置就越靠近。我提议创建两个推荐键：一个用于代码相似性，另一个用于问题相似性。这样，用户就能比费心浏览相应代码库和文档更快地识别出其他可能有用的软件包。我会重点关注较大的软件包，并尝试展示它们与较小软件包之间的关联，而不是列出软件包之间的所有可能关联（此方法也将扩展到更新教程，在其中应指出与其他软件包的关联）。此方法可保证“其他资源”列表包含丰富的信息，但不会详尽列出软件包组合。