Projektideen

Aktuelle Phase:
Die Saison 2019 für Google Docs wurde am 6. März 2020 beendet. Siehe Zeitachse.

Die Projektideen sind Vorschläge einer Open-Source-Organisation für Projekte, die technische Redakteure während der „Season of Docs“ gemeinsam mit einem Mentor ausführen können.

Die Informationen auf dieser Seite richten sich an Administratoren und Mentoren von Open-Source-Organisationen, die ihre Liste mit Projektideen zusammenstellen. Die Informationen sind auch für technische Redakteure nützlich, um mehr über die Beteiligung der Organisationen an „Season of Docs“ zu erfahren.

Beispielprojekte

Hier sind einige Ideen für Projekte, die technische Redakteure in Angriff nehmen können:

  • Erstellen Sie auf einer Plattform eine Dokumentationswebsite, die vom technischen Autor und Open-Source-Mentor ausgewählt wird, und veröffentlichen Sie erste grundlegende Dokumente auf der Website. Beispiele für Plattformen:

  • Refaktorieren Sie die vorhandene Dokumentation des Open-Source-Projekts, um die Nutzerfreundlichkeit zu verbessern oder die Informationsarchitektur besser zugänglich zu machen.

  • Schreiben Sie eine konzeptionelle Übersicht oder Einführung in ein Produkt oder eine Funktion. Oft erstellt ein Team seine technische Dokumentation von Grund auf neu. Das Ergebnis sind zwar viele Details, aber das Produkt als Ganzes lässt sich nur schwer verstehen. Ein technischer Redakteur kann dieses Problem beheben.

  • Erstellen Sie ein Tutorial für einen bekannten Anwendungsfall.

  • Sie erstellen eine Reihe gezielter Anleitungen für bestimmte Aufgaben.

  • Erstellen Sie einen Leitfaden für Beitragende, der grundlegende Informationen zu den ersten Schritten als Mitwirkender am Open-Source-Projekt sowie Regeln zu Lizenzvereinbarungen, Prozessen für Pull-Anfragen und Überprüfungen, Erstellung des Projekts usw. enthält.

Die oben genannten Ideen variieren absichtlich in Umfang und Umfang. Die Dauer eines Projekts hängt von einer Reihe von Faktoren ab, darunter die Größe der Dokumentation, die Komplexität des Produkts, die Erfahrung der Fachleute für technische Redakteure und Open-Source-Mentoren, die im Open-Source-Projekt angebotenen Tools und Prozesse und mehr.

Die obige Liste soll Ihnen den Einstieg erleichtern. Sie können auch andere Arten von Projekten vorschlagen.

Liste mit Projektideen veröffentlichen

Sie sollten Ihre Projektideen auf einer öffentlichen Webseite, in einem Blogpost oder in einem anderen öffentlich sichtbaren Dokument veröffentlichen.

Die Seite mit Projektideen sollte Folgendes enthalten:

  • Informationen zu Ihrer Open-Source-Organisation:

    • Name der Organisation.
    • Beschreibung der Organisation.
    • Ein Link zu Ihrem Open-Source-Repository und/oder Ihrer Website.
    • (Optional) Eine E-Mail-Adresse, unter der Sie Ihre Organisation bezüglich Season of Docs kontaktieren können. Dies sollte mit der E-Mail-Adresse übereinstimmen, die du im Antragsformular deiner Organisation für "Season of Docs" angibst.
    • (Optional) Informationen zu den Administratoren und Mentoren Ihrer Organisation, z. B. deren Anzeigenamen. Diese sollten mit den Anzeigenamen übereinstimmen, die Sie im Antragsformular Ihrer Organisation für „Season of Docs“ angeben.

  • Hiermit möchten wir Sie darüber informieren, dass sich Ihre Organisation für die diesjährige Saison der Dokumente bewirbt. Die Werbe- und Presseseite enthält Logos und andere Inhalte, die Sie zum Thema "Season of Docs" verwenden können.

  • Ihre Projektideen, einschließlich der unten beschriebenen Informationen für jede Projektidee.

Wenn Sie für Ihre Organisation einen Antrag für „Season of Docs“ erstellen, sollten Sie einen Link zu Ihrer Seite mit Projektideen angeben.

Informationen in jeder Projektidee

Jede Projektidee muss mindestens die folgenden Informationen enthalten:

  • Projektname:Wählen Sie einen prägnanten, aber aussagekräftigen Titel.
  • Beschreibung:Eine längere Beschreibung der erforderlichen Dokumentation. Beschreiben Sie Ihre ursprüngliche Idee ausführlich. Interessierten Redakteuren die Möglichkeit bieten, die Idee zu erweitern oder zu verfeinern.

  • Ähnliches Material:

    • Link zum Open-Source-Projekt, für das eine Dokumentation erforderlich ist.
    • Wenn Sie ein Projekt für technisches Schreiben vorschlagen, das Aktualisierungen eines vorhandenen Dokumentationssatzes umfasst, verlinken Sie auf diesen Dokumentationssatz.
    • Wenn Sie eine oder mehrere Anleitungen vorschlagen, beschreiben Sie die Features oder Anwendungsfälle, die dokumentiert werden müssen.
    • Wenn Sie das Handbuch eines Mitwirkenden vorschlagen, verlinken Sie auf eine vorhandene Readme-Datei oder anderes relevantes Material, sofern vorhanden. Wenn noch nichts verfügbar ist, kann ich das sagen.
    • Fügen Sie gegebenenfalls Links zu ähnlicher Dokumentation in anderen Projekten hinzu.

Die Bedeutung der Projektideen

Ihre Projektideen sind in vielerlei Hinsicht wichtig:

  • Die Arbeit an den Ideen hilft Ihrer Organisation, die erforderlichen Dokumentationsaufgaben zu formulieren und sich auf die Zusammenarbeit mit einem technischen Redakteur vorzubereiten.
  • Die Projektideen geben den Google-Programmadministratoren einen Anhaltspunkt für die Art der Arbeit, die ein technischer Redakteur übernimmt, wenn er eine Mentoring-Beziehung zu Ihrer Organisation eingeht. Die Google-Programmadministratoren nutzen die Projektideen, um zu beurteilen, ob sich die Organisation für die Teilnahme an Season of Docs und die Betreuung eines technischen Redakteurs während des gesamten Programms einsetzt.
  • Mit den Projektideen können Sie interessierte technische Redakteure auf Ihr Unternehmen aufmerksam machen. Die Teammitglieder können Ihre vorgeschlagenen Projekte als Grundlage für ihre eigenen Projektvorschläge verwenden.
  • Die Werbe- und Presseseite enthält Logos und andere Inhalte, die Sie zum Thema "Season of Docs" verwenden können.
  • In diesem Video von der PyCon Australia 2017 erfahren Sie, wie Sie Ihre Dokumentation so strukturieren können, dass sie für andere nützlich ist: What nobody goes you about documentation von Daniele Procida.