Julia Language 项目

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

项目摘要

开源组织:
Julia 语言
技术文档工程师:
sophb
项目名称:
重塑 FluxML 网站
项目时长:
标准时长(3 个月)

Project description

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

该项目包括以下阶段:

  • 分析当前文档网站:审核现有信息并定义用于创建新教程的风格指南(其中)。

  • 定义信息和入门教程的新结构:与导师一起确定文档网站的新部分并重新组织。此外,以 Flux 60-mine-blitz 教程为起点,定义入门教程的目录,并在此基础上继续构建。

  • 重新调整信息结构:使用在上一步中与导师合作制定的计划更新网站。

  • 创建入门教程:撰写初稿并检查。获得导师的反馈。导师和我确定本文档有最终版本后,就会将其发布到文档网站上。

  • (可选)将 README 形式的现有文档转换为 HTML:如果完成四个主要阶段后还有一些时间,我可以转换现有的自述教程,以便可以更轻松地从网站访问它们。

为了实现该项目的目标,我将与 Flux 社区密切合作,以便了解现有文档并确定最佳方法。我是 Julia 的新手,我相信这对于为新的入门教程确定正确的信息级别会非常有用。

我的工作重点是确保我的工作能够帮助 Flux 社区开发新的用途。此外,我将着重帮助有经验的用户发现新的应用场景,并探索 Flux 的细节。