Aktuelle Phase:
Fallstudien wurden veröffentlicht. Siehe Zeitachse.
Diese Seite richtet sich an Open-Source-Organisationen, die sich in der Explorationsphase des Bewerbungsprozesses befinden. Diese Projektideen sind nur Beispiele, die zeigen, wie Organisationen mögliche Dokumentationsprojekte auf der Seite mit Projektideen der 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 benötigen, um sinnvolle Beiträge zu unserem Projekt zu leisten. Einige Prozesse (z. B. die Mitarbeit an unseren Tests) sind 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 „gutes Ersteinstiegsproblem“
Welche Fähigkeiten sollte ein Technischer Redakteur für dieses Projekt haben?
- Erforderlich:Gute GitHub-Kenntnisse (oder Bereitschaft, GitHub-Anleitungen durchzugehen)
- Optional:Kenntnisse 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 Dokumente.
- @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 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, ich überprüfe gerne Pull-Anfragen für Dokumente.
Kontaktdaten
- Technische Redakteure, die an diesem Projekt arbeiten möchten, sollten eine E-Mail an email@project senden. Fügen Sie 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, ich überprüfe gerne Pull-Anfragen für Docs.
Kontaktdaten
- Technische Redakteure, die an diesem Projekt arbeiten möchten, sollten eine E-Mail an email@project senden. Fügen Sie 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 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 beim Organisieren des Videos und Chats für die Fehlerbehebung helfen und bei der Suche nach Freiwilligen in anderen Zeitzonen behilflich sein
Kontaktdaten
- Technische Redakteure, die an diesem Projekt arbeiten möchten, sollten eine E-Mail an email@project senden oder ein Problem melden oder in unserem Forum fragen. Fügen Sie Links zu Ihren technischen Texten oder zu Ihrem Portfolio/Lebenslauf hinzu.
Projektidee: Dokumentation prüfen
Problem
- Wir wissen nicht genau, in welchem Zustand sich unsere Dokumentation befindet. 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-Veranstaltung helfen
Kontaktdaten
- Technische Redakteure, die an diesem Projekt arbeiten möchten, sollten eine E-Mail an email@project senden oder ein Problem melden oder in unserem Forum fragen. Fügen Sie 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.