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:
- Data Commons
- Technischer Redakteur:
- KilimAnnejaro
- Projektname:
- Verbesserung der Dokumentation zu DataCommons
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
In meiner Laufbahn als Softwareentwickler war ich immer wieder frustriert, wenn ich einem neuen Team oder Projekt beigetreten bin, ein Code-Repository heruntergeladen und ausgeführt habe und die Software abstürzte, weil wichtige Schritte in der Dokumentation fehlten. Ich erkannte schnell, dass ich meine lebenslange Leidenschaft für das Schreiben und Komponieren auf diese Anforderungen anwenden konnte. Dabei schuf ich eine unterstützende Umgebung für die Entwickler, mit denen ich zusammenarbeitete, damit sie sich auf technische Innovationen und Kreativität konzentrieren konnten, anstatt Probleme mit bekannten Antworten zu lösen.
Diese technische Innovation und Kreativität ist in vielen Bereichen der Gesellschaft dringend erforderlich, insbesondere für Führungskräfte in der öffentlichen Verwaltung und im Nonprofit-Sektor, die Datasets in ihren Problembereichen analysieren möchten. Durch die Bereitstellung dieser Daten als Service senkt DataCommons die Zugangsbarriere für Analysten, die Daten suchen, die leicht zugänglich sind und dem Format entsprechen, das sie für ihre Rolle benötigen. Dazu erstellt DataCommons einen Knowledge Graph aus den aufgenommenen Daten und wirft dabei interessante Fragen zur Datenqualität und -verwaltung im Kontext von Open Source auf. Mit meiner Bewerbung für Google Summer of Docs mit einem Vorschlag für die Organisation DataCommons hoffe ich, diese technischen Bemühungen im Bereich der offenen Daten im öffentlichen Interesse zu unterstützen und voranzutreiben.
Aktuelle Probleme in der Dokumentation mit vorgeschlagenen Lösungen Die Website von dataCommons enthält zwar eine Anleitung zum Hinzufügen von Datensätzen zu dataCommons, diese ist jedoch sehr kurz und unklar. Sie besteht aus mehreren Aufzählungspunkten, in denen die potenziellen Datengeber aufgefordert werden, schema.org-Markup zu verwenden. Im Rahmen dieses Projekts möchte ich den Abschnitt „Mitmachen“ von dataCommons.org überarbeiten. Ich werde eine Anleitung zum Hinzufügen neuer Datensätze erstellen, in der erklärt wird, wie Datensätze gescraped und in den Knowledge Graph von dataCommons aufgenommen werden. Außerdem füge ich einen Abschnitt mit häufig gestellten Fragen hinzu, in dem häufige Lösungen vorgeschlagen werden, wenn sich der Inhaber eines Datensatzes an die Verantwortlichen von dataCommons wendet.
Die aktuellen Beispiele für die Abfrage von Daten bei dataCommons umfassen nur vier interaktive Codebeispiele, die alle Python-Notebooks sind. Im Rahmen dieses Projekts übersetze ich diese Notebooks in R und erstelle interaktive Demoversionen der vorliegenden Beispiele für Google Tabellen und die REST API. Diese Demos werden in die aktuelle Dokumentation eingebettet.
Schließlich bietet die Dokumentation keine Beispiele dafür, wie der Knowledge Graph von dataCommons zum Erstellen von Softwareanwendungen verwendet werden kann. Im Rahmen dieses Projekts erstelle, implementiere und dokumentiere ich ein Beispieltool in Python, das die dataCommons API nutzt, um Endnutzern die Erstellung grafischer Visualisierungen zu ermöglichen, die sich auf zwei im Wissensgraphen verbundene Werte beziehen. Mit diesem Tool können Sie beispielsweise eine lineare Regression erstellen, die Wetterdaten mit Informationen zu gängigen Geschäftsmustern in Beziehung setzt. Als ambitioniertes Ziel hoffe ich, dieses Tool auf andere Arten von Visualisierungen wie Kreisdiagramme und Venn-Diagramme ausweiten zu können.
Zeitplan Die Saison läuft vom 14. September bis zum 30. November. Mein Plan für die Fertigstellung dieses Projekts sieht also wie folgt aus:
September: Beginnen Sie mit dem Umschreiben des Abschnitts „Mitmachen“. Schließen Sie diese Arbeit bis Ende September weitgehend ab.
Oktober: Schließen Sie den Abschnitt „Mitmachen“ ab und erstellen Sie die interaktiven Codebeispiele.
November: Erstellen Sie das Beispiel-Visualisierungstool.