本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Julia 语言
- 技术文档工程师：
- 刘硕
- 项目名称：
- LightGraphs Docs 2.0 和简单易用的 JuliaGraphs 教程
- 项目时长：
- 长时间运行（5 个月）
Project description
在这个长期运作的项目中，我会完善 JuliaGraphs 中模块的网站和文档。具体而言，我的工作将包括但不限于以下内容。
LightGraphs 文档 2.0 - 10 周
- 概览：LightGraphs.jl 是专为 Julia 优化的轻量级图形软件包，是 JuliaGraphs 生态系统的核心。即将发布的 LightGraphs 2.0 版本代表了 LightGraphs API 的重大变更。我会确保文档中介绍的是 LightGraphs 的最新功能。
- 交付成果：我将对现有 API 文档进行审核，看看哪些文档可以保持不变，并分析 2.0 版中所做的更改，确保通过示例对其进行正确记录。在此过程中，我会撰写一些帖子，重点介绍 2.0 版中的重大变更。为了帮助新手更好地了解 LightGraphs，我将为刚开始在 Julia 中使用图的用户创建入门指南。
- 注意：在此项目中，Documenter.jl 将用作文档生成器来构建 LightGraphs 文档。除了 Coloring.jl 等模块的 API 参考文档之外，我还需要为 greedy_color.jl 等子模块添加 API 参考文档。我将探索如何添加这些文档，以更新 LightGraphs 文档。此外，图表理论是一门技术性很强的数学领域，对没有数学背景的人来说并不陌生。我从事学术研究已有大约 2 年的时间，并在自己的个人网站上撰写了许多博文，因此在创作新手入门指南时，我有信心解释不同算法的要点，并提示在各种情况下应使用哪种算法。
JuliaGraphs 教程 - 10 周
- 概览：JuliaGraphs 软件包的许多文档面向开发者。我会添加一些简单的示例，并说明每项功能的用法，以便用户更轻松地使用。
- 交付成果：我会审核现有的 LightGraphs 教程，了解需要添加哪些材料，并说明每项功能的用法和动机。然后，我将按照 JuliaGraphsTutorials 的方式扩展 JuliaGraphs 教程，包括 LightGraphs 生态系统中的新手入门指南。
- 注意：目前，JuliaGraphsTutorials 的内容不够全面，上面列出的交付内容主要是 LightGraphs 软件包。如果时间允许，我还会添加 JuliaGraphs 中其他模块（例如 GraphPlot.jl、MetaGraphs.jl 和 SimpleWeightedGraphs.jl）的教程。
JuliaGraphs Central 网站 - 4 周
- 概览：JuliaGraphs 的中央网站提供了该生态系统软件包的概览。不过，它主要只是描述，可以进一步改进，成为刚开始使用 Julia 中的图表的人的第一项资源。我将通过直观的可视化方式，突出各种 JuliaGraphs 软件包的功能。
- 交付成果：我将提供用例和示例来重点介绍 JuliaGraphs 软件包的功能，并执行审核，确保这些软件包仍然相关且受支持。我将创建一个部分，重点介绍各种软件包在不同领域（医疗保健、教育等）中的不同用途如果时间允许，我会研究有关图表中所用算法的直观说明。
- 注意：许多 JuliaGraphs 软件包已在不同领域广泛使用。除了绘图扩展程序（例如 DiGraph for NetworkViz）之外，我还将介绍一些特定学科的其他应用，例如生物学中的 MetaGraph for BioStructures、城市规划中的 DijkstraState for TrafficAssighnment、教育中的 DiGraph for TreeView 等。