Aktuelle Phase:
Ergebnisse wurden bekannt gegeben. 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, die zeigen, wie Organisationen mögliche Dokumentationsprojekte auf der Seite mit Projektideen ihrer Organisation beschreiben könnten. Organisationen können auch Projekte vorschlagen, die nicht in dieser Liste enthalten sind.
Projektidee: Onboarding-Leitfaden für Mitwirkende erstellen
Problem
- Neue Mitwirkende können die Informationen zur Einrichtung nicht finden, die sie für einen sinnvollen Beitrag zu unserem Projekt benötigen. Einige Prozesse (z. B. die Mitarbeit an unseren Tests) werden gar nicht dokumentiert.
Wie würden wir den Erfolg messen?
- Mehr neue Mitwirkende
- Mehr neue Mitwirkende, die keine Code-Entwickler sind (durch eine einfachere Beteiligung an Dokumenten 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, happy to review docs pull requests
- @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 es kann schwierig sein.
Wie würden wir den Erfolg messen?
- Rückgang der Anzahl der 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 $TechnologieX
Ehrenamtliche Helfer
Fordern Sie Communitymitglieder auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen, z. B.:
- @JaneQDev, kann Fragen zu $TechnologyX beantworten
- @ChenPCoder, happy to review docs pull requests
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 unübersichtlich 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 würden wir den Erfolg messen?
- Bessere SEO für unsere Dokumentation
- Weniger Probleme bei Themen, die in der Dokumentation behandelt werden
- Mehr Dokumentationsbeiträge
Welche Fähigkeiten sollte ein Technischer Redakteur für dieses Projekt haben?
- Von Vorteil:Erfahrung mit der Neuorganisation großer und ausgereifter Dokumentationssätze, Kenntnisse im Bereich SEO
Ehrenamtliche Helfer
Fordern Sie Communitymitglieder auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen, z. B.:
- @ChenPCoder, happy to review docs pull requests
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: Dokumentationsfehler beheben
Problem
- Es gibt viele kleine Fehler und alte Probleme im Zusammenhang mit unserer Dokumentation. Unsere Community würde sich gern beteiligen und mithelfen, die Probleme zu beheben. Wir brauchen aber jemanden, der die eigentliche Bereinigung 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 arbeiten möchten, sollten eine E-Mail an email@project senden oder ein Problem in unserem Forum melden. 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, Verbesserungen an der Dokumentation zu priorisieren, da wir keine Roadmap haben und nicht wissen, welche Probleme am dringendsten 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 Seiten in der Dokumentation
Welche Fähigkeiten sollte ein Technischer Redakteur für dieses Projekt haben?
- Von Vorteil:Erfahrung mit der Überprüfung von Dokumenten
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 arbeiten möchten, sollten eine E-Mail an email@project senden oder ein Problem in unserem Forum melden. Fügen Sie bitte Links zu Ihren technischen Texten oder zu Ihrem Portfolio/Lebenslauf hinzu.
Weitere Informationen
- 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.