Projektideen

Aktuelle Phase:
Das Programm „Season of Docs“ 2021 endete am 14. Dezember 2021. Siehe Zeitachse.

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

Projektidee: Leitfaden für neue Mitwirkende erstellen

Problem

  • Neue Mitwirkende können die Informationen zur Einrichtung nicht finden, die sie benötigen, um sinnvolle Beiträge zu unserem Projekt zu leisten. Einige Prozesse (z. B. die Mitarbeit an unseren Tests) werden gar nicht dokumentiert.

Wie würden wir den Erfolg messen?

  • Mehr neue Mitwirkende
  • Erhöhung der Anzahl neuer Mitwirkender ohne Code (durch einfachere Unterstützung für Dokumente oder Tests)
  • Rückgang der Anzahl der von neuen Mitwirkenden gemeldeten Probleme
  • Mehr geschlossene Probleme mit dem Tag „Good First Issue“

Welche Fähigkeiten sollte ein Technischer Redakteur für dieses Projekt haben?

  • Erforderlich:Gute GitHub-Kenntnisse (oder Bereitschaft, GitHub-Anleitungen durchzugehen)
  • Optional:Erfahrung mit unserem Test Runner, um unsere Tests auszuführen und die Dokumentation entsprechend zu aktualisieren

Ehrenamtliche Helfer

Fordern Sie Communitymitglieder auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen, z. B.:

  • @JaneQDev kann Fragen zu unseren Tests beantworten.
  • @ChenPCoder, ich überprüfe gerne Pull-Anfragen für Docs.
  • @ErichJEngineer, can walk through current contribution process with technical writer

Kontaktdaten

  • Technische Redakteure, die an diesem Projekt arbeiten möchten, sollten eine E-Mail an email@project senden. Fügen Sie bitte Links zu Ihren technischen Texten oder zu Ihrem Portfolio/Lebenslauf hinzu.

Projektidee: Anleitungen zur Verwendung unserer Bibliothek mit…

Problem

  • Unser Projekt erhält viele Probleme von Nutzern, die versuchen, unsere Bibliothek mit $TechnologyX zu verwenden. Wir haben keine klare Anleitung für die Integration mit $TechnologyX und dies kann schwierig sein.

Wie würden wir den Erfolg messen?

  • Weniger Probleme mit dem Tag „$TechnologyX“
  • Mehr Pull-Requests von neuen Mitwirkenden, die uns dabei helfen, Fehler zu beheben oder die Dokumentation zu $TechnologyX zu ergänzen
  • Weitere Links zu unserem Projekt aus Projekten von $TechnologyX

Welche Fähigkeiten sollte ein Technischer Redakteur für dieses Projekt haben?

  • Von Vorteil:Ein gewisses Maß an Erfahrung mit $TechnologyX

Ehrenamtliche Helfer

Fordern Sie Communitymitglieder auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen, z. B.:

  • @JaneQDev, kann Fragen zu $TechnologyX beantworten
  • @ChenPCoder, gerne überprüft Pull-Anfragen der Dokumente

Kontaktdaten

  • Technische Redakteure, die an diesem Projekt arbeiten möchten, sollten eine E-Mail an email@project senden. Fügen Sie bitte Links zu Ihren technischen Texten oder zu Ihrem Portfolio/Lebenslauf hinzu.

Projektidee: Dokumentation neu strukturieren

Problem

  • Unsere Dokumentation ist umfangreich und unorganisiert. Viele Nutzer geben auf, Antworten in der Dokumentation zu finden, und stellen stattdessen Probleme oder Fragen in unseren Foren. Unsere Seiten werden nicht in den Suchergebnissen angezeigt, auch nicht für relevante Keywords.

Wie können wir 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ötigt ein technischer Redakteur, um an diesem Projekt zu arbeiten?

  • Von Vorteil:Erfahrung mit der Neuorganisation großer und ausgereifter Dokumentensammlungen, Kenntnisse im Bereich SEO

Ehrenamtliche Helfer

Fordern Sie Communitymitglieder auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen, z. B.:

  • @ChenPCoder, ich überprüfe gerne Pull-Anfragen für Docs.

Kontaktdaten

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

Projektidee: Dokumentationsfehler beheben

Problem

  • Im Zusammenhang mit unserer Dokumentation gibt es viele kleine Fehler und alte Probleme. Unsere Community würde sich gern beteiligen und mithelfen, die Probleme zu beheben. Wir brauchen aber jemanden, der die eigentliche Behebung organisiert und durchführt.

Wie würden wir den Erfolg messen?

  • Anzahl der geschlossenen dokumentationsbezogenen Probleme
  • Mehr Dokumentationsbeiträge und neue Mitwirkende

Welche Fähigkeiten sollte ein Technischer Redakteur für dieses Projekt haben?

  • Von Vorteil:Erfahrung mit der Durchführung eines Fixits für die Dokumentation
  • Gute organisatorische Fähigkeiten

Ehrenamtliche Helfer

Fordern Sie Communitymitglieder auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen, z. B.:

  • @ChenPCoder, kann helfen, das Video und den Chat für die Fehlerbehebung zu organisieren und Freiwillige in anderen Zeitzonen zu finden

Kontaktdaten

  • Technische Redakteure, 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. Fügen Sie bitte Links zu Ihren technischen Texten oder zu Ihrem Portfolio/Lebenslauf hinzu.

Projektidee: Dokumentation prüfen

Problem

  • Wir haben keine genaue Vorstellung vom Stand unserer Dokumentation. Es ist schwierig, Dokumentationsverbesserungen zu priorisieren, da wir keine Roadmap oder kein Verständnis dafür haben, was die dringendsten Probleme sind. Außerdem gibt es viele veraltete Inhalte, die gelöscht oder archiviert werden sollten.

Wie würden wir den Erfolg messen?

  • Erstellung einer Dokumentations-Roadmap mit allgemeiner Zustimmung der Community
  • Verringerung der Anzahl der veralteten oder falschen Dokumentationsseiten

Welche Fähigkeiten benötigt ein technischer Redakteur, um an diesem Projekt zu arbeiten?

  • Gut zu haben: Erfahrung in der Durchführung von Dokumentenprüfung

Ehrenamtliche Helfer

Fordern Sie Communitymitglieder auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen, z. B.:

  • @JaneQCoder, kann bei der Koordinierung der Präsentation der Dokumentations-Roadmap in unserer Community-Besprechung helfen

Kontaktdaten

  • Technische Redakteure, 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 Ihren technischen Arbeiten oder Ihrem Portfolio/Lebenslauf/Lebenslauf an.
  • Die Seite Werbung und Presse enthält Logos und andere Inhalte, die Sie verwenden können, wenn Sie über die Google Season of Docs sprechen.
  • In diesem Video von der PyCon Australia 2017 erhalten Sie Tipps dazu, wie Sie Ihre Dokumentation so organisieren, dass sie für andere nützlich ist: What nobody tells you about documentation von Daniele Procida.