Diese Seite wurde von der Cloud Translation API übersetzt.

INF-Projekt

Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:: INCF
Technischer Redakteur:: hq
Projektname:: LORIS-Schulungsdokumente für offene reproduzierbare Neurowissenschaften
Projektlänge:: Lang andauernd (5 Monate)

Projektbeschreibung

I. Zusammenfassung

Das Longitudinal Online Research and Imaging System (LORIS) ist eine webbasierte Projektmanagementplattform für die Bildgebungsforschung,die mehrere Open-Science-Initiativen unterstützt. Die Dokumentation spielt in LORIS eine wichtige Rolle. Insbesondere helfen die Dokumentationen den LORIS-Nutzern und -Entwicklern, Softwaredetails 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 zielt darauf ab, LORIS bei der Verbesserung seiner Dokumentation zu unterstützen.

II. Aktueller Status

LORIS verwendet derzeit GitHub-Wiki, Read the Docs und die LORIS.ca-Website zum Hosten der gesamten Dokumentation. Insbesondere das LORIS-GitHub-Wiki enthält die größte Menge an LORIS-Dokumentation. Zusätzliche LORIS-Anleitungen, 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 durch Aktualisierungen der Dokumentation und Verbesserungen der technischen Details.

III. Vorteile für die Community

Durch die Verbesserung der LORIS-Trainingsdokumente 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 werden insbesondere die Installations-/Einrichtungsdokumentation von LORIS sowie die Materialien für Endnutzer aktualisiert und verbessert, die eine Schulung für neue Nutzer bieten. Außerdem soll das Projekt dazu beitragen, die Dokumentation aus dem LORIS-GitHub-Wiki zu Read the Docs zu migrieren und zu aktualisieren. In der Zwischenzeit kann das Projekt ein Datenbankdiagramm enthalten, um Datenbeziehungen zu veranschaulichen und die Architekturvisualisierung zu verbessern. Schließlich werden im Rahmen dieses Projekts Inhalte aktualisiert und verbessert, die LORIS, seinen Open-Science-Kontext und seine Anwendungsfälle vorstellen.

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

In den letzten Jahren habe ich an mehreren technischen Projekten teilgenommen, durch die ich mir umfassende Kenntnisse im Bereich technisches Schreiben angeeignet habe. Insbesondere war ich in mehreren früheren Teamprojekten für die Erstellung von Dokumentationen verantwortlich und ich glaube, dass ich ausreichend Erfahrung mit Tools für die technische Dokumentation wie Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX usw. habe. Außerdem haben meine bisherigen Lehrerfahrungen in STEM-Kursen meine Fähigkeiten in der technischen Kommunikation verbessert. Die LORIS-Trainingsdokumente für offene reproduzierbare Neurowissenschaftsprojekte mit INCF wären eine gute Gelegenheit für mich, meine Techniken für technisches Schreiben auf LORIS anzuwenden. Außerdem interessiere ich mich sehr für den Bereich Neuroimaging und suche nach Möglichkeiten, mein technisches Wissen in diesem Bereich anzuwenden. Die LORIS-Trainingsdokumente für offene reproduzierbare Neurowissenschaftsprojekte mit INCF wären eine wertvolle Erfahrung für mich.

V. Liefergegenstände

Aktuelle LORIS-Dokumentation migrieren und aktualisieren
Prüfen, aktualisieren und verbessern Sie die Installations-/Einrichtungsdokumentation für LORIS und schließen Sie Lücken in den Endnutzermaterialien, die Schulungen für neue Nutzer bieten.
Erstellen Sie ein Datenbankdiagramm, um Datenbeziehungen (z. B. Thema, Studienbesuch) zu veranschaulichen und die Architekturvisualisierung zu verbessern.
Bei der Aktualisierung und Verbesserung der LORIS API-Dokumentation helfen
Inhalte aktualisieren und verbessern, die LORIS, seinen Open-Science-Kontext und seine Anwendungsfälle in verschiedenen Medienformaten vorstellen

VI. Zeitachse

Teambuilding (17. August bis 13. September) a) Einführung in die LORIS-Software und den Teamablauf. b) Überprüfung, Aktualisierung und Verbesserung der LORIS-Installations-/Einrichtungsdokumentation.

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

Woche 2 (21. September bis 27. September) a) Sehen Sie sich das aktuelle LORIS-Endnutzermaterial an. b) Lücken in den LORIS-Materialien für Endnutzer schließen und Schulungen für neue Nutzer auf der Grundlage der aktuellen Dokumentation anbieten.

Woche 3 (28. September bis 4. Oktober) Füllen Sie die Lücken in den LORIS-Materialien für Endnutzer auf, die ein Training für neue Nutzer bieten.

Woche 4 (5. 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) Schließen Sie die Aufgabe zum Generieren des LORIS-Datenbankdiagramms ab. b) Sehen Sie sich die aktuelle LORIS API an und tragen Sie zur Verbesserung der API-Dokumentation bei.

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

Woche 7 (26. Oktober bis 1. November) Verbesserungen an der LORIS API-Dokumentation abschließen.

Woche 8 (2. bis 8. November) Sehen Sie sich die aktuellen Inhalte an, in denen Nutzer mit LORIS vertraut gemacht werden, und aktualisieren und verbessern Sie den Kontext für Open Science.

Woche 9 (9. bis 15. November) Fertigstellen der Aktualisierungen und Verbesserungen des Kontexts der offenen Wissenschaft in den Inhalten, in denen LORIS vorgestellt wird.

Woche 10 (16. November bis 22. November) Du kannst dabei helfen, einen Teil der Anwendungsfälle in den Inhalten zur Einführung von LORIS zu aktualisieren und zu verbessern.

Woche 11 (23. November bis 29. November) Die Aktualisierung und Optimierung aller Anwendungsfälle in den Inhalten zur Einführung von LORIS wird abgeschlossen.

Projektabschluss (30. November bis 5. Dezember) a) Alle von mir erstellten Dokumentationsbeiträge bereinigen. b) Alle erstellten Pull-Requests auf GitHub zusammenführen und alle von mir erstellten Probleme schließen. c) Den endgültigen Projektbericht fertigstellen und an Google senden.

VII. Zukünftige Leistungen

Nach der Google Season of Docs 2020 möchte ich meine Beiträge zur Dokumentation für LORIS fortsetzen. Insbesondere möchte ich mit den LORIS-Entwicklern über die Möglichkeit sprechen, die Dokumentation für neue Releases weiter zu aktualisieren und zu erstellen. Außerdem möchte ich mir die Zeit nehmen, die Dokumentation zu überprüfen, die ich während meines Google Season of Docs-Projekts erstellt habe, und zu prüfen, ob es noch Verbesserungsmöglichkeiten gibt. Da ich einen entsprechenden technischen Hintergrund habe, bin ich auch bereit, in Zukunft an anderen Aspekten der LORIS-Software mitzuwirken, z. B. an der Softwareentwicklung.