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:
- Data Commons
- Technischer Redakteur:
- KilimAnnejaro
- Projektname:
- Dokumentation zu den ersten Schritten mit DataCommons verbessern
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
In meiner Karriere als Softwareingenieurin war ich immer wieder frustriert über die Erfahrung, einem neuen Team oder Projekt beigetreten zu sein, ein Code-Repository herunterzuladen, es auszuführen und zu beobachten, wie die Software kaputtgeht, wenn wichtige Schritte in der Dokumentation fehlten. Ich erkannte schnell, dass ich meine lebenslange Leidenschaft für das Schreiben und Komponieren auf diese Bedürfnisse anwenden konnte. Dadurch schaffte ich eine unterstützende Umgebung für die Entwickler, mit denen ich zusammengearbeitet habe, und konnte mich auf technische Innovation und Kreativität konzentrieren, anstatt Probleme mit bekannten Antworten zu lösen.
Diese technische Innovation und Kreativität wird in vielen Teilen der Gesellschaft dringend benötigt, insbesondere von Führungskräften im Regierungs- und Nonprofit-Sektor, die Datensätze in ihren Problembereichen analysieren möchten. DataCommons stellt diese Daten als Service bereit und senkt damit die Eintrittsbarriere für Analysten, die nach Daten suchen, die leicht zugänglich sind und dem Format entsprechen, das sie für ihre Rolle benötigen. Zu diesem Zweck erstellt DataCommons einen Knowledge Graph der aufgenommenen Daten. Dabei werden interessante Fragen zu Datenqualität und Governance im Rahmen von Open Source aufgeworfen. Ich habe mich mit einem Vorschlag für die DataCommons-Organisation für Google Summer of Docs beworben und hoffe, diese technischen Bemühungen im Open Data-Bereich des öffentlichen Interesses zu unterstützen und voranzutreiben.
Aktuelle Probleme in der Dokumentation mit vorgeschlagenen Lösungen Die dataCommons-Website enthält zwar Anweisungen zum Hinzufügen von Datensätzen zu dataCommons, aber die Anweisungen sind sehr kurz und unklar, da sie aus mehreren Aufzählungspunkten bestehen, die den potenziellen Datenspender auffordern, schema.org-Markup zu verwenden. Im Rahmen dieses Projekts schlage ich vor, den Abschnitt „Machen Sie sich ein“ von dataCommons.org zu bereinigen. Ich werde ein Tutorial zum Hinzufügen neuer Datasets erstellen, in dem erklärt wird, wie Datasets extrahiert und in den dataCommons Knowledge Graph eingebunden werden. Ich werde auch einen FAQ-Bereich für gängige Lösungen hinzufügen, die vorgeschlagen werden, wenn sich ein Dataset-Inhaber an die dataCommons-Praktiker wendet.
Bei der Betrachtung der aktuellen Beispiele für das Abfragen von Daten bietet dataCommons nur vier interaktive Codebeispiele, alle davon Python-Notebooks. Im Rahmen dieses Projekts übersetze ich diese Notebooks in R und erstelle interaktive Demoversionen der aktuellen Beispiele für Google Tabellen und die REST API, um diese Demos in die aktuelle Dokumentation einzubetten.
Und schließlich enthält die Dokumentation keine wirklich Beispiele dafür, wie der dataCommons Knowledge Graph zum Erstellen von Anwendungen in Software verwendet werden kann. Im Rahmen dieses Projekts werde ich ein Beispieltool in Python erstellen, bereitstellen und dokumentieren, das die dataCommons API verwendet, um dem Endnutzer die Erstellung grafischer Visualisierungen zu zwei beliebigen im Knowledge Graph verbundenen Größen zu ermöglichen. Mit diesem Tool kann beispielsweise eine lineare Regression zwischen Wetterdaten und Informationen zu gängigen Geschäftsmustern gezeichnet werden. Außerdem möchte ich dieses Tool auf andere Visualisierungsarten wie Kreisdiagramme und Venn-Diagramme ausweiten.
Zeitplan Die Saison läuft vom 14. September bis zum 30. November. Daher sieht mein Plan zur Durchführung dieses Projekts wie folgt aus:
September: Beginnen Sie mit der Umformulierung des Abschnitts "Mitmachen" und stellen Sie die Arbeit größtenteils bis Ende September fertig.
Oktober: Schließen Sie den Abschnitt „Jetzt mitmachen“ ab und erstellen Sie die interaktiven Codebeispiele.
November: Erstellen Sie das Beispiel-Visualisierungstool.