INF-Projekt

Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:

INCF

Technischer Redakteur:

hq

Projektname:

LORIS-Trainingsdokumentation für offene reproduzierbare Neurowissenschaften

Projektdauer:

Langfristig (5 Monate)

Projektbeschreibung

I. Zusammenfassung

Das Longitudinal Online Research and Imaging System (LORIS) ist eine webbasierte Projektmanagementplattform für Neuroimaging-Forschung,die mehrere Open Science-Initiativen unterstützt. In LORIS spielt die Dokumentation eine wichtige Rolle. Insbesondere helfen die Dokumentationen LORIS-Nutzern und ‐Entwicklern, Softwaredetails besser zu verstehen, damit sie die Plattform besser nutzen oder zur Softwareentwicklung beitragen können. In der Zwischenzeit sollte 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 finden Sie auf dem LORIS GitHub-Wiki die umfangreichste LORIS-Dokumentation. 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 Anleitungen für LORIS-Entwickler und -Nutzer. Sie könnte jedoch von einer weiteren Entwicklung und Organisation profitieren, insbesondere bei Aktualisierungen und Verbesserungen der technischen 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 Datenerhebung in ihren Studien zu verbessern. Im Rahmen des Projekts können insbesondere die Dokumentation zur Installation und Einrichtung von LORIS sowie Materialien für Endnutzer aktualisiert und verbessert werden, 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 „Lesen Sie die Dokumente“ zu aktualisieren. In der Zwischenzeit kann das Projekt ein Datenbankdiagramm enthalten, um Datenbeziehungen zu kommunizieren und die Visualisierung der Architektur zu verbessern. Schließlich würde dieses Projekt Inhalte aktualisieren und verbessern, in denen Menschen LORIS, seinen offenen wissenschaftlichen Kontext und seine Anwendungsfälle vorgestellt werden.

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

In den letzten Jahren war ich an mehreren technischen Projekten beteiligt, durch die ich über fundierte Kenntnisse im technischen Bereich des Schreibens verfügte. Vor allem war ich für das Schreiben von Dokumentationen in mehreren früheren Teamprojekten verantwortlich und glaube, dass ich genug Erfahrung im Umgang mit technischen Schreibtools wie Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX usw. habe. Mittlerweile habe ich meine Erfahrung in MINT-Kursen auch 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-Schulungsdokumente für offene reproduzierbare neurowissenschaftliche Projekte mit IncF wären eine wertvolle Erfahrung für mich.

V. Liefergegenstände

1. Aktuelle LORIS-Dokumentation migrieren und aktualisieren
2. Lesen, aktualisieren und verbessern Sie die Dokumentation zur Installation/Einrichtung von LORIS und schließen Sie Lücken in den Endnutzermaterialien, die Schulungen für neue Nutzer enthalten.
3. Helfen Sie bei der Erstellung eines Datenbankdiagramms, 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. Inhalte aktualisieren und verbessern, in denen LORIS, sein offener Wissenschaftskontext und Anwendungsfälle in mehreren Medienformaten vorgestellt werden

VI. Zeitplan

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

Woche 1 (14. September–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-Endnutzermaterialien zu schließen, die Schulungen für neue Nutzer anbieten, basierend auf der aktuellen Dokumentation.

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

Woche 4 (5. Oktober–11. Oktober) a) Überblick über die aktuelle LORIS-Datenbankarchitektur. b) Mit der Implementierung des Datenbankdiagramms für die LORIS-Plattform beginnen.

Woche 5 (12. Oktober bis 18. Oktober) a) Aufgaben zur Generierung des LORIS-Datenbankdiagramms abschließen. b) Aktuelle LORIS API ansehen und die API-Dokumentation verbessern

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

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

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

Woche 9 (9. November–15. November) Ende der Updates und Verbesserungen des Open-Science-Kontexts bei der Einführung in LORIS

Woche 10 (16. November–22. November) Hilf mit, einen Teil der Anwendungsfälle in Inhalten zu aktualisieren und zu verbessern, in denen LORIS vorgestellt wird.

Woche 11 (23. November–29. November) Schließe die Aktualisierung und Verbesserung aller Anwendungsfälle in den Inhalten ab, in denen Nutzern LORIS vorgestellt wird.

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 von mir erstellten Probleme. c) Fertigen Sie meinen endgültigen Projektbericht an und senden Sie den Bericht an Google.

VII. Künftige Liefergegenstände

Ich möchte auch nach der Saison 2020 an Google Docs weiter an der Dokumentation für LORIS arbeiten. Insbesondere möchte ich mit LORIS-Entwicklern besprechen, wie wir weiterhin Dokumentationen für neue Releases aktualisieren und erstellen können. Außerdem würde ich mich gerne etwas Zeit nehmen, um die Dokumentation zu überprüfen, die ich während meines Google-Projekts für die Zeit der Docs erstellt habe, und zu prüfen, ob es noch mehr Raum für Verbesserungen gibt. Da ich über einen einschlägigen technischen Hintergrund verfügt, bin ich offen dafür, auch in Zukunft an anderen Aspekten der LORIS-Software zu arbeiten, beispielsweise in der Softwareentwicklung.