Julia Language 项目

本页面包含 Google 文档季接受的技术写作项目的详细信息。

项目摘要

开源组织：
Julia 语言
技术文档工程师：
sophb
项目名称：
重新打造 FluxML 网站
项目时长：
标准时长（3 个月）

Project description

此方案旨在改进 Flux 的文档网站，使其包含的信息条理清晰，对新手和专家具有吸引力。更具体地说，目标是将现有文档重新组织为新的部分，并为新手创建新的入门教程，以扩展 Flux 60-mine-blitz 教程。

该项目包括以下阶段：

  • 分析当前文档网站：审核现有信息并定义用于创建新教程的风格指南（关于该信息）。

  • 为信息和入门教程定义新的结构：与导师一起确定新的部分并重新组织文档网站。此外，请使用 Flux 60-mine-blitz 教程作为起点，为入门教程定义目录，并在此基础上进行构建。

  • 调整信息结构：使用与上一步骤中的导师协作制定的计划来更新网站。

  • 创建入门教程：撰写初稿并复习。获取导师的反馈。当我和导师确定本文档已是最终版本后，我会将其发布到文档网站上。

  • （可选）将现有的 README 文档转换为 HTML 文档：如果我在完成四个主要阶段后还有一些时间，可以将现有的 README 教程转换为 HTML 文档，以便用户更轻松地从网站上访问这些教程。

为了实现项目目标，我将与 Flux 社区密切合作，了解现有文档并确定最佳方法。我自己也是 Julia 的新手，相信这对确定新入门教程中信息的适当级别非常有帮助。

我的工作重点是确保我的工作能帮助 Flux 社区掌握新的用途。此外，我还将专注于帮助经验丰富的用户发现新的应用场景，并探索 Flux 的更精细细节。