本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- INCF
- 技术文档工程师：
- 高清
- 项目名称：
- 有关开放式可再现神经科学的 LORIS 培训文档
- 项目时长：
- 长期投放（5 个月）
Project description
I. 摘要
经度在线研究和成像系统 (LORIS) 是一个面向网络的项目管理平台，用于神经成像研究，支持多项开放科学计划。在 LORIS 中，文档发挥着重要作用。具体而言，文档可以帮助 LORIS 用户和开发者了解软件细节，以便他们可以更好地使用平台或为软件开发做出贡献。同时，LORIS 文档也应随之更新。此项目旨在帮助 LORIS 改进其文档。
II. 当前状态
LORIS 目前使用 GitHub Wiki、阅读 Google 文档和 LORIS.ca 网站来托管所有文档。具体而言，LORIS GitHub Wiki 托管着最多的 LORIS 文档，其他 LORIS 教程、演示文稿、用户指南和演示也托管在各种平台中。当前的 LORIS 文档为 LORIS 开发者和用户提供了指南，但进一步的开发和整理会对其有所帮助，特别是在文档更新和技术细节的改进方面。
III. 社区福利
通过改进有关开放式可重现神经科学的 LORIS 培训文档，研究人员和开发者将受益于一种更加人性化的工具，从而改进研究中的数据收集。具体而言，该项目可能会更新和改进 LORIS 安装/设置文档，以及为新用户提供培训的最终用户材料。此外，该项目的宗旨是帮助迁移，以及从 LORIS GitHub Wiki 将文档更新为“阅读文档”。同时，该项目可能会提供数据库图来传达数据关系并改进架构可视化。最后，该项目将更新并改进向人们介绍 LORIS、其开放的科学背景及其应用场景的内容。
IV. 项目的个人强项
在过去的几年里，我参与了几个技术项目，凭借这些项目，我在技术写作方面拥有深厚的背景。具体而言，我曾在之前的多个团队项目中负责撰写文档，并且我相信我在使用技术写作工具（如 Read the Docs、Sphinx、Mkdocs、markdown、LaTeX 等）方面拥有足够的经验。与此同时，我之前在 STEM 课程中的教学经验也提升了我在技术沟通方面的技能。我可以通过 INCF 将我的技术写作技巧运用到 LORIS 中，这个绝佳的机会就在于这些关于与 IncF 合作进行可重现的神经科学项目的 LORIS 培训文档。此外，我对神经成像领域非常感兴趣，并一直在寻找机会来将我的技术知识运用到该领域。对我来说，有关使用 IncF 进行可复现的神经科学项目的 LORIS 培训文档是非常宝贵的经验。
V. 交付成果
- 迁移并更新当前的 LORIS 文档
- 查看、更新和改进 LORIS 安装/设置文档，并填补最终用户材料中的缺口，为新用户提供培训
- 帮助生成数据库图来传达数据关系（例如主题、研究访问）并改进架构可视化
- 帮助更新和改进 LORIS API 文档
- 帮助更新和改进内容，向人们介绍 LORIS、其开放的科学背景及其应用场景（涉及多种媒体形式）
VI. 时间表
社区绑定（8 月 17 日至 9 月 13 日） a) 完全熟悉 LORIS 软件和团队工作流程。 b) 查看、更新和改进 LORIS 安装/设置文档。
第 1 周（9 月 14 日至 9 月 20 日） 更新 LORIS 文档并将其从 GitHub Wiki 迁移到“阅读文档”。
第 2 周（9 月 21 日至 9 月 27 日） a) 查看当前的 LORIS 最终用户材料。 b) 根据当前文档，开始在为新用户提供培训的 LORIS 最终用户材料中填补空白。
第 3 周（9 月 28 日至 10 月 4 日） 填补 LORIS 最终用户材料中的空白，为新用户提供培训。
第 4 周（10 月 5 日至 10 月 11 日） a) 了解当前的 LORIS 数据库架构。 b) 开始为 LORIS 平台实现数据库图表。
第 5 周（10 月 12 日至 10 月 18 日） a) 完成 LORIS 数据库图表生成任务。 b) 查看当前的 LORIS API，并开始帮助改进 API 文档。
第 6 周（10 月 19 日至 10 月 25 日） 继续改进 LORIS API 文档。
第 7 周（10 月 26 日至 11 月 1 日）完成对 LORIS API 文档的改进。
第 8 周（11 月 2 日至 11 月 8 日） 审核当前向人们介绍 LORIS 的内容，并开始更新并改进科学开放的背景。
第 9 周（11 月 9 日至 11 月 15 日） 在向人们介绍 LORIS 的内容中完成对开放科学背景的更新和改进。
第 10 周（11 月 16 日至 11 月 22 日） 帮助更新和改进介绍 LORIS 的内容中的部分用例。
第 11 周（11 月 23 日 - 11 月 29 日）完成对介绍 LORIS 的内容中所有用例的更新和改进。
项目完成（11 月 30 日 - 12 月 5 日） a) 清理我创建的所有文档贡献内容。 b) 合并 GitHub 上创建的所有拉取请求，并关闭我创建的所有问题。 c) 完成最终项目报告，并将报告提交给 Google。
VII. 未来交付成果
在 Google 文档 2020 季过后，我想继续为 LORIS 的文档贡献力量。具体而言，我想与 LORIS 开发者讨论继续为新版本更新和创建文档的可能性。此外，我还想花些时间仔细查看我在 Google 文档季期间创建的文档，看看是否有更多改进空间。最后，我拥有相关的工程背景，因此乐意在未来为 LORIS 软件的其他方面做贡献，例如软件开发。