INF-Projekt

Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:

INCF

Technischer Redakteur:

hq

Projektname:

LORIS-Schulungsdokumente für offene reproduzierbare Neurowissenschaften

Projektdauer:

Lange Ausführung (5 Monate)

Projektbeschreibung

I. Zusammenfassung

Das Longitudinal Online Research and Imaging System (LORIS) ist eine webbasierte Projektmanagementplattform für die Neuroimaging-Forschung,die mehrere Open Science-Initiativen unterstützt. Dokumentation spielt bei LORIS eine wichtige Rolle. Insbesondere helfen sie LORIS-Nutzern und -Entwicklern dabei, die Softwaredetails besser zu verstehen, damit sie die Plattform besser nutzen oder zur Softwareentwicklung beitragen können. In der Zwischenzeit sollte auch die LORIS-Dokumentation aktualisiert werden. Dieses Projekt soll LORIS dabei unterstützen, seine Dokumentation zu verbessern.

II. Aktueller Status

LORIS nutzt derzeit GitHub Wiki, Read the Docs und die LORIS.ca-Website, um die gesamte Dokumentation zu hosten. Insbesondere das LORIS GitHub-Wiki hostet die meisten LORIS-Dokumentationen und weitere LORIS-Tutorials, Präsentationen, Nutzerhandbücher und Schritt-für-Schritt-Anleitungen werden auf einer Vielzahl von Plattformen gehostet . Die aktuelle LORIS-Dokumentation enthält Leitfäden für LORIS-Entwickler und -Nutzer. Sie könnte jedoch von einer weiteren Entwicklung und Organisation profitieren, insbesondere bei Aktualisierungen der Dokumentation und Verbesserungen technischer Details.

III. Vorteile für die Community

Durch die Verbesserung der LORIS-Schulungsdokumente für offene reproduzierbare Neurowissenschaften würden Forscher und Entwickler von einem nutzerfreundlicheren Tool profitieren, um die Datenerfassung in ihren Studien zu verbessern. Konkret wird durch das Projekt die Dokumentation zur Installation und Einrichtung von LORIS sowie Materialien für Endnutzer aktualisiert und verbessert, die Schulungen für neue Nutzer enthalten. Darüber hinaus soll das Projekt dabei helfen, zu migrieren und die Dokumentation vom LORIS GitHub-Wiki auf „Read the Docs“ zu aktualisieren. In der Zwischenzeit kann das Projekt ein Datenbankdiagramm enthalten, um Datenbeziehungen zu kommunizieren und die Architekturvisualisierung zu verbessern. Dieses Projekt würde auch Inhalte aktualisieren und verbessern, in denen LORIS, sein offener Wissenschaftskontext und seine Anwendungsfälle vorgestellt werden.

IV. Persönliche Stärken für das Projekt

In den letzten Jahren habe ich an mehreren technischen Projekten teilgenommen und mir umfassende Kenntnisse im technischen Bereich erworben. Insbesondere war ich für das Schreiben von Dokumentationen in mehreren früheren Teamprojekten verantwortlich und ich glaube, dass ich genug Erfahrung in der Verwendung technischer Schreibtools wie Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX usw. habe. Gleichzeitig hat meine bisherige Erfahrung in MINT-Kursen meine Fähigkeiten in der technischen Kommunikation verbessert. Die LORIS-Schulungsdokumente für offene reproduzierbare neurowissenschaftliche Projekte mit IncF sind eine gute Gelegenheit für mich, meine technischen Schreibtechniken bei LORIS anzuwenden. Darüber hinaus interessiere ich mich sehr für Neuroimaging und suche nach Möglichkeiten, mein technisches Wissen in diesem Bereich anzuwenden. Die LORIS-Schulungsunterlagen für offene reproduzierbare neurowissenschaftliche Projekte mit IncF wären für mich eine wertvolle Erfahrung.

V. Liefergegenstände

1. Aktuelle LORIS-Dokumentation migrieren und aktualisieren
2. Lesen, aktualisieren und verbessern Sie die Dokumentation zur Installation und Einrichtung von LORIS und schließen Sie Lücken in Endnutzermaterialien, die Schulungen für neue Nutzer anbieten.
3. Bei der Erstellung eines Datenbankdiagramms helfen, um Datenbeziehungen (z.B. Thema, Studienbesuch) zu kommunizieren und die Architekturvisualisierung zu verbessern
4. Helfen Sie uns, die LORIS API-Dokumentation zu aktualisieren und zu verbessern
5. Wir möchten Inhalte aktualisieren und verbessern, in denen LORIS, sein offener wissenschaftlicher Kontext und seine Anwendungsfälle in verschiedenen Medienformaten vorgestellt werden.

VI. Zeitplan

Community Bonding (17. August bis 13. September) a) Sich mit der LORIS-Software und dem Team-Workflow vertraut machen b) Dokumentation zur Installation/Einrichtung von LORIS lesen, aktualisieren und verbessern

Woche 1 (14. September bis 20. September) Aktualisieren und migrieren Sie die LORIS-Dokumentation vom GitHub-Wiki zu „Read the Docs“.

Woche 2 (21. September bis 27. September) a) Überprüfen Sie die aktuellen LORIS-Endnutzermaterialien. b) damit beginnen, die Lücken in den LORIS-Materialien für Endnutzer zu schließen, die Schulungen für neue Nutzer auf der Grundlage der aktuellen Dokumentation anbieten.

Woche 3 (28. September bis 4. Oktober) LORIS-Endnutzermaterialien für Schulungen für neue Nutzer ausfüllen

Woche 4 (5. Oktober bis 11. Oktober) a) Die aktuelle LORIS-Datenbankarchitektur verstehen b) Mit der Implementierung des Datenbankdiagramms für die LORIS-Plattform beginnen

Woche 5 (12. Oktober bis 18. Oktober) a) Beenden Sie die Aufgabe zum Generieren des LORIS-Datenbankdiagramms. b) Prüfen Sie die aktuelle LORIS API und optimieren Sie die API-Dokumentation.

Woche 6 (19. Oktober bis 25. Oktober) Arbeiten Sie weiter an der Verbesserung der LORIS API-Dokumentation.

Woche 7 (26. Oktober bis 1. November) Verbesserung der Dokumentation zur LORIS API abschließen.

Woche 8 (2. November bis 8. November) Sehen Sie sich die aktuellen Inhalte an, in denen LORIS vorgestellt wird, und aktualisieren Sie die Inhalte, um den offenen wissenschaftlichen Kontext zu verbessern.

Woche 9 (9. November bis 15. November) Updates und Verbesserungen des offenen wissenschaftlichen Kontexts bei der Einführung von LORIS durch andere Nutzer abgeschlossen

Woche 10 (16. November bis 22. November) Helfen Sie uns, einen Teil der Anwendungsfälle in den Inhalten zu aktualisieren und zu verbessern, in denen LORIS vorgestellt wird.

Woche 11 (23. November bis 29. November) Update und Verbesserung aller Anwendungsfälle für LORIS-Inhalte abschließen

Projektabschluss (30. November bis 5. Dezember) a) Bereinigen Sie alle von mir erstellten Dokumentationsbeiträge. b) Führen Sie alle erstellten Pull-Anfragen auf GitHub zusammen und schließen Sie alle erstellten Probleme. c) Fertigstellen meines abschließenden Projektberichts und Senden des Berichts an Google

VII. Zukünftige Liefergegenstände

Ich möchte auch nach der Saison 2020 an der Dokumentation für LORIS weiterarbeiten. Ich würde gern mit LORIS-Entwicklern sprechen, wie wir auch weiterhin Dokumentationen für neue Releases erstellen und aktualisieren können. Darüber hinaus würde ich mir gerne etwas Zeit nehmen, um die Dokumentation zu überprüfen, die ich im Rahmen meines Projekts "Google Season of Docs" erstellt habe, und zu prüfen, ob es noch Verbesserungspotenzial gibt. Da ich über einen einschlägigen technischen Hintergrund bin, bin ich bereit, mich in Zukunft auch bei anderen Aspekten der LORIS-Software einzubringen, z. B. in der Softwareentwicklung.