Projektideen

Aktuelle Phase:
Bekanntgabe der Ergebnisse. Siehe Zeitachse.

Diese Seite richtet sich an Open-Source-Organisationen, die sich in der Erkundungsphase des Bewerbungsprozesses für Organisationen befinden. Diese Projektideen sind nur Beispiele, die zeigen, wie Organisationen mögliche Dokumentationsprojekte auf der Seite für Projektideen der Organisation beschreiben können. Organisationen können Projekte vorschlagen, die nicht in dieser Liste enthalten sind.

Projektidee: Onboarding-Leitfaden für Beitragende erstellen

Problem

  • Neue Beitragende können nicht die Informationen finden, die sie benötigen, um sinnvolle Beiträge zu unserem Projekt zu leisten. Einige Prozesse, z. B. die Beteiligung an unseren Tests, sind überhaupt nicht dokumentiert.

Wie lässt sich der Erfolg messen?

  • mehr neue Mitwirkende
  • Steigerung der Anzahl neuer Mitwirkender ohne Code (durch vereinfachtes Einreichen von Beiträgen zu Dokumenten oder Tests)
  • Weniger Probleme von neuen Mitwirkenden
  • Gestiegene Anzahl geschlossener Probleme, die mit „gutes erstes Problem“ gekennzeichnet sind

Welche Fähigkeiten benötigen technische Redakteure, um an diesem Projekt zu arbeiten?

  • Erforderlich: Kenntnisse von GitHub (oder Bereitschaft, GitHub-Anleitungen zu bearbeiten)
  • Vorteilhaft:Kenntnisse des Test-Runners, um Tests durchzuführen und die Dokumentation zu aktualisieren

Freiwillige Helfer

Ermuntern Sie Community-Mitglieder dazu, sich für bestimmte Aufgaben zu registrieren, zum Beispiel:

  • @JaneQDev beantwortet Fragen zu unseren Tests.
  • @ChenPCoder, gern prüfen die Pull-Anfragen für Dokumente
  • @ErichJEngineer, kann den aktuellen Beitragsprozess mit dem technischen Redakteur besprechen

Kontaktdaten

  • Technische Autoren, die an diesem Projekt mitarbeiten möchten, sollten eine E-Mail an email@project senden. Bitte geben Sie Links zu Ihren technischen Texten oder zu Ihrem Portfolio, Ihrem Lebenslauf oder Ihrem Lebenslauf an.

Projektidee: Schreiben Sie Tutorials zur Verwendung unserer Bibliothek mit ...

Problem

  • Unser Projekt erhält viele Probleme, die von Nutzern gemeldet werden, die versuchen, unsere Bibliothek mit $TechnologyX zu verwenden. Wir haben keinen klaren Leitfaden für die Integration von $TechnologyX und das kann schwierig sein!

Wie lässt sich der Erfolg messen?

  • Weniger Probleme mit dem Tag „$TechnologyX“
  • Erhöhte Anzahl von Pull-Anfragen von neuen Mitwirkenden, die uns helfen, Programmfehler zu beheben oder die Dokumentation zu $TechnologyX hinzuzufügen.
  • Weitere Links zu unserem Projekt von $TechnologyX-Projekten

Welche Fähigkeiten benötigen technische Redakteure, um an diesem Projekt zu arbeiten?

  • Gut zu wissen: Erfahrung mit $TechnologyX

Freiwillige Helfer

Ermuntern Sie Community-Mitglieder dazu, sich für bestimmte Aufgaben zu registrieren, zum Beispiel:

  • @JaneQDev kann Ihnen bei der Beantwortung von Fragen zu $TechnologyX helfen
  • @ChenPCoder, gern prüfen die Pull-Anfragen für Dokumente

Kontaktdaten

  • Technische Autoren, die an diesem Projekt mitarbeiten möchten, sollten eine E-Mail an email@project senden. Bitte geben Sie Links zu Ihrer technischen Arbeit oder Ihrem Portfolio/Lebenslauf/Lebenslauf an.

Projektidee: Dokumentation neu organisieren

Problem

  • Unsere Dokumentation ist umfangreich und unorganisiert. Viele Nutzer möchten nicht in der Dokumentation nach Antworten suchen und können stattdessen Probleme oder Fragen in unseren Foren stellen. Unsere Seiten erscheinen nicht in den Suchergebnissen, selbst wenn sie relevante Suchbegriffe eingeben.

Wie lässt sich der Erfolg messen?

  • Bessere SEO für unsere Dokumentation
  • Weniger Probleme bei Themen, die in der Dokumentation behandelt werden
  • Gestiegene Anzahl von Dokumentationsbeiträgen

Welche Fähigkeiten benötigen technische Redakteure, um an diesem Projekt zu arbeiten?

  • Gut zu haben: Erfahrung mit der Umstrukturierung umfangreicher und ausgereifter Dokumentationen, Verständnis von SEO

Freiwillige Helfer

Ermuntern Sie Community-Mitglieder dazu, sich für bestimmte Aufgaben zu registrieren, zum Beispiel:

  • @ChenPCoder, gern prüfen die Pull-Anfragen für Dokumente

Kontaktdaten

  • Technische Autoren, die an diesem Projekt mitarbeiten möchten, sollten eine E-Mail an email@project senden. Bitte geben Sie Links zu Ihrer technischen Arbeit oder Ihrem Portfolio/Lebenslauf/Lebenslauf an.

Projektidee: Dokumentationskorrektur ausführen

Problem

  • Im Zusammenhang mit unserer Dokumentation gibt es viele kleine Fehler und alte Probleme. Unsere Community würde sich gerne melden und bei der Bereinigung helfen, aber wir brauchen jemanden, der die eigentliche Reparatur organisiert und ausführt.

Wie lässt sich der Erfolg messen?

  • Anzahl der behobenen Dokumentationsprobleme
  • Mehr Dokumentationsbeiträge und neue Beitragende

Welche Fähigkeiten benötigen technische Redakteure, um an diesem Projekt zu arbeiten?

  • Von Vorteil: Erfahrung beim Ausführen einer Dokumentationskorrektur
  • Hervorragende organisatorische Fähigkeiten

Freiwillige Helfer

Ermuntern Sie Community-Mitglieder dazu, sich für bestimmte Aufgaben zu registrieren, zum Beispiel:

  • @ChenPCoder, kann bei der Organisation des Videos und Chats für den Fixit helfen und Freiwillige in anderen Zeitzonen finden.

Kontaktdaten

  • Technische Autoren, die an diesem Projekt mitarbeiten möchten, sollten eine E-Mail an email@project senden/ein Problem in unserem Forum stellen oder eine Frage stellen. Bitte geben Sie Links zu Ihrer fachlichen Schreibarbeit oder Ihrem Portfolio/Lebenslauf/Lebenslauf an.

Projektidee: Dokumentationsprüfung durchführen

Problem

  • Wir haben keine genaue Vorstellung vom Status unserer Dokumentation. Es ist schwierig, der Verbesserung der Dokumentation Priorität einzuräumen, da wir keine Roadmap und keinen Überblick über die dringendsten Probleme haben. Außerdem haben wir eine Menge veralteter Inhalte, die gelöscht oder archiviert werden sollten.

Wie lässt sich der Erfolg messen?

  • Erstellung einer Roadmap für die Dokumentation mit allgemeiner Genehmigung durch die Community
  • Weniger veraltete oder falsche Dokumentationsseiten

Welche Fähigkeiten benötigen technische Redakteure, um an diesem Projekt zu arbeiten?

  • Von Vorteil: Erfahrung bei der Durchführung von Dokumentenprüfungen

Freiwillige Helfer

Ermuntern Sie Community-Mitglieder dazu, sich für bestimmte Aufgaben zu registrieren, zum Beispiel:

  • @JaneQCoder kann bei der Präsentation der Dokumentations-Roadmap in unserem Community-Meeting helfen.

Kontaktdaten

  • Technische Autoren, die an diesem Projekt mitarbeiten möchten, sollten eine E-Mail an email@project senden/ein Problem in unserem Forum stellen oder eine Frage stellen. Bitte geben Sie Links zu Ihrer fachlichen Schreibarbeit oder Ihrem Portfolio/Lebenslauf/Lebenslauf an.
  • Die Werbe- und Presseseite enthält Logos und andere Inhalte, die Sie verwenden können, wenn Sie über Google Season of Docs sprechen.
  • 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.