本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- INCF
- 技术文档工程师：
- hq
- 项目名称：
- LORIS 培训文档：开放可重现的神经科学
- 项目时长：
- 长期（5 个月）
Project description
I. 摘要
纵向在线研究和成像系统 (LORIS) 是一个面向网络的项目管理平台，适用于神经影像研究，支持多项开放科学计划。文档在 LORIS 中发挥着重要作用。具体而言，文档可帮助 LORIS 用户和开发者了解软件详情，以便更好地使用该平台或为软件开发做出贡献。与此同时，LORIS 文档也应更新。此项目旨在帮助 LORIS 改进其文档。
II. 当前状态
LORIS 目前使用 Github Wiki、Read the Docs 和 LORIS.ca 网站托管所有文档。具体而言，LORIS GitHub Wiki 上托管了最多的 LORIS 文档，其他 LORIS 教程、演示文稿、用户指南和演示文稿则托管在各种平台上。当前的 LORIS 文档为 LORIS 开发者和用户提供了指南，但仍有待进一步开发和整理，尤其是在文档更新和技术细节改进方面。
III. 对社区的好处
通过改进关于开放式可重现神经科学的 LORIS 培训文档，研究人员和开发者将受益于更加人性化的工具，从而改善研究中的数据收集。具体而言，该项目可能会更新和改进 LORIS 安装/设置文档，以及面向新用户提供培训的最终用户材料。此外，该项目还旨在帮助将文档从 LORIS GitHub Wiki 迁移和更新到 Read the Docs。与此同时，该项目可能会提供一个数据库图表，用于传达数据关系并改进架构可视化。最后，该项目将更新和改进介绍 LORIS、其开放科学背景和用例的内容。
IV. 项目的个人优势
在过去几年里，我参与了多个技术项目，从中积累了扎实的技术写作背景。具体而言，我曾负责过多个团队项目的文档编写工作，并且我相信自己在使用 Read the Docs、Sphinx、Mkdocs、Markdown、LaTeX 等技术写作工具方面有足够的经验。与此同时，我之前在 STEM 课程中的教学经验也提升了我的技术沟通技能。通过 INCF 为可重现的开放式神经科学项目编写的 LORIS 培训文档，为我提供了一个绝佳的机会，让我将自己的技术写作技巧应用于 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 迁移到 Read the Docs。
第 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. 未来的交付内容
在 2020 年 Google 文档季结束后，我想继续为 LORIS 的文档做出贡献。具体而言，我想与 LORIS 开发者讨论是否有可能继续更新和创建新版本的文档。此外，我想花些额外的时间来检查我在 Google 文档季项目期间创建的文档，看看是否还有改进空间。最后，由于我拥有相关的工程背景，因此我很乐意在未来为 LORIS 软件的其他方面（例如软件开发）做出贡献。