本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织:
- INCF
- 技术文档工程师:
- Ogbonoko
- 项目名称:
- The Turing Way: A How-to Guide to Data Science
- 项目时长:
- 标准时长(3 个月)
Project description
简介
随着数据科学的普及和应用的多样化,它已成为吸引各个领域、不同专业水平的学生、研究人员、行业专家和专业人士的领域。为了促进该领域的发展,让更多数据科学爱好者能够访问数据科学研究,并持续访问,这一点至关重要。实现这一目标的方法之一是,遵循有关开展可重现、可重复使用且协作的数据科学研究的指南。
《图灵之道》便是这样的指南之一,其使命是“确保可重现的数据科学‘太容易做到’”。目前,《图灵之道》包含的内容涵盖可重现的研究、项目设计、沟通、协作和道德研究。不过,随着《图灵之道》的范围不断扩大,我们需要编辑支持,才能将新创建的内容纳入现有工作中。
项目目标
概括来讲,作为该项目的技术编写人员,我的工作是通过以下方式让数据科学界更容易上手使用《图灵之道》:
审核《图灵之道》的现有章节,寻找改进其语言和结构的方法,
将新内容纳入现有作品中,同时保持《图灵之道》的整体风格和基调一致,
以新章节、互动式教程和/或案例研究的形式贡献新内容。
时间轴
如果我的申请成功,我提议以以下方式完成此项目:
8 月 17 日之前:
尽可能为《图灵之道》做出贡献(更正拼写错误等)
熟悉“图灵之道”中当前包含的信息
提高写作和编辑技能,同时熟悉我将要使用的工具。
社区互动阶段(8 月 17 日至 9 月 23 日):
主动与“图灵之路”背后的团队/社区互动,详细了解该项目。
建立并维护与导师的沟通渠道。
在导师和整个社区的反馈下,优化并最终确定项目目标。
第 1 周(9 月 14 日 - 9 月 19 日)
在第一周,我需要妥善设置必要的工具,以确保我的工作效率。
此外,我在阅读《图灵之道》时发现了一些拼写错误。不过,我打算在 8 月 17 日之前在贡献项目时更正这些错误。我建议在前几周内仔细阅读该图书的现有章节,确保其语法、拼写和措辞准确、一致,并能吸引项目的目标受众群体。
首先,我将在标题为“Guide for Reproducible Research”(可再现性研究指南)的章节开始校对阶段。
第 2 周(9 月 20 日 - 9 月 26 日)
校对并修改标题为“项目设计指南”的章节以及所有新贡献的内容,并根据需要建议更改。
第 3 周(9 月 27 日至 10 月 3 日)
校对并修改名为“沟通指南”的章节。
第 4 周(10 月 4 日至 10 月 10 日)
校对并修改标题为“协作指南”的章节,并处理新的内容贡献。
第 5 周(10 月 11 日至 10 月 17 日)
校对并修改标题为“伦理研究指南”的章节以及所有新贡献的内容。
第 6 周(10 月 18 日至 10 月 24 日)
校对并修改标题为“项目设计指南”的章节以及所有新贡献的内容。
第 7 周(10 月 25 日至 10 月 31 日)
在项目导师的指导下,为 The Turing Way 集思广益并创作新内容。这些新内容可以是新章节、教程或案例研究的形式。例如,我目前正在撰写论文,并致力于开发播客检索和理解方法。我可以将这次体验和学习成果记录为一个案例。
第 8-10 周(11 月 1 日 - 11 月 28 日)
完成第 7 周内容的文档,同时校对其他人贡献的所有新内容。
第 12 周(11 月 29 日 - 12 月 5 日)
优化书面内容,确保其准确无误、符合事实和一致。我还会记录并提交自己对于项目成功的想法以及对导师的评估结果。