Aktuelle Phase:
Dokumentationsentwicklung. 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 der Projektideen der Organisation beschreiben können. Organisationen können Projekte vorschlagen, die nicht in dieser Liste enthalten sind.
Projektidee: Leitfaden zum Onboarding von Beitragenden erstellen
Problem
- Neue Beitragende finden nicht die Informationen zur Einrichtung, die sie benötigen, um sinnvolle Beiträge zu unserem Projekt zu leisten. Einige Prozesse (z. B. Beiträge zu unseren Tests) sind überhaupt nicht dokumentiert.
Wie würden wir Erfolg messen?
- mehr neue Beitragende
- Steigerung der Anzahl neuer Mitwirkender ohne Code (durch Erleichterung des Beitrags zu Dokumenten oder Tests)
- Weniger Probleme von neuen Beitragenden
- Anstieg der Anzahl geschlossener Probleme, die mit „Gutes erstes Problem“ gekennzeichnet sind
Welche Fähigkeiten benötigen technische Redakteure, um an diesem Projekt zu arbeiten?
- Voraussetzung: Kenntnisse von GitHub (oder Bereitschaft, mit GitHub-Anleitungen zu arbeiten)
- Vorteil: Vertrautheit mit unserem Test-Runner, um unsere Tests auszuführen und die Dokumentation dafür zu aktualisieren
Freiwillige Helfer
Fordere Community-Mitglieder dazu auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen. Beispiele:
- @JaneQDev beantwortet Fragen zu unseren Tests
- @ChenPCoder, wir prüfen gerne Dokumente zum Abrufen von Anfragen
- @ErichJEngineer, kann den aktuellen Beitragsprozess mit einem technischen Redakteur durchgehen
Kontaktdaten
- Technische Autoren, die an diesem Projekt mitarbeiten möchten, sollten eine E-Mail an email@project senden. Geben Sie Links zu Ihren technischen Arbeiten oder Ihr Portfolio/Ihre Lebensläufe an.
Projektidee: Tutorials zur Verwendung unserer Bibliothek mit ...
Problem
- Unser Projekt erhält viele Probleme, die von Nutzern geäußert werden, die versuchen, unsere Bibliothek mit $TechnologyX zu verwenden. Wir haben leider keinen eindeutigen Leitfaden für die Integration von $TechnologyX und es kann schwierig sein.
Wie würden wir Erfolg messen?
- Weniger Probleme mit dem Tag „$TechnologyX“
- mehr Pull-Anfragen von neuen Mitwirkenden, die uns helfen, Fehler zu beheben, oder die Dokumentation
- Weitere Links zu unserem Projekt aus $TechnologyX-Projekten
Welche Fähigkeiten benötigen technische Redakteure, um an diesem Projekt zu arbeiten?
- Von Vorteil: Erfahrung mit $TechnologyX
Freiwillige Helfer
Fordere Community-Mitglieder dazu auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen. Beispiele:
- @JaneQDev beantwortet Fragen zu $TechnologyX.
- @ChenPCoder, wir prüfen gerne Dokumente zum Abrufen von Anfragen
Kontaktdaten
- Technische Autoren, die an diesem Projekt mitarbeiten möchten, sollten eine E-Mail an email@project senden. Geben Sie Links zu Ihren technischen Arbeiten oder Ihr Portfolio/Ihre Lebensläufe an.
Projektidee: Dokumentation neu organisieren
Problem
- Unsere Dokumentation ist umfassend und unübersichtlich. Viele Nutzer geben auf, nach Antworten in der Dokumentation zu suchen, und stellen einfach Probleme oder stellen Fragen in unseren Foren. Unsere Seiten erscheinen auch bei relevanten Suchbegriffen nicht in den Suchergebnissen.
Wie würden wir Erfolg messen?
- Bessere SEO für unsere Dokumentation
- Weniger Probleme für Themen, die in der Dokumentation behandelt werden
- Mehr Dokumentationsbeiträge
Welche Fähigkeiten benötigen technische Redakteure, um an diesem Projekt zu arbeiten?
- Gut zu wissen: Erfahrung mit der Restrukturierung umfangreicher und ausgereifter Dokumentationen, Verständnis von SEO
Freiwillige Helfer
Fordere Community-Mitglieder dazu auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen. Beispiele:
- @ChenPCoder, wir prüfen gerne Dokumente zum Abrufen von Anfragen
Kontaktdaten
- Technische Autoren, die an diesem Projekt mitarbeiten möchten, sollten eine E-Mail an email@project senden. Geben Sie Links zu Ihren technischen Arbeiten oder Ihr Portfolio/Ihre Lebensläufe an.
Projektidee: Dokumentations-Fixit ausführen
Problem
- Im Zusammenhang mit unserer Dokumentation gibt es viele kleine Fehler und alte Probleme. Unsere Community würde gerne einen Beitrag leisten und bei der Bereinigung helfen, aber wir brauchen jemanden, der die eigentliche Reparatur organisiert und ausführt.
Wie würden wir 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 Beheben von Dokumentationskorrekturen
- Hervorragende organisatorische Fähigkeiten
Freiwillige Helfer
Fordere Community-Mitglieder dazu auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen. Beispiele:
- @ChenPCoder, kann bei der Organisation der Videos und Chats für den Fixit helfen und Freiwillige in anderen Zeitzonen finden.
Kontaktdaten
- Technische Autoren, die an diesem Projekt arbeiten möchten, sollten eine E-Mail an email@project/ein Problem senden oder in unserem Forum eine Frage stellen. Geben Sie Links zu Ihrer technischen Schreibarbeit oder Ihrem Portfolio/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äten zu setzen, da wir keine Roadmap oder einen Überblick über die dringendsten Probleme haben. Außerdem gibt es viele veraltete Inhalte, die gelöscht oder archiviert werden sollten.
Wie würden wir Erfolg messen?
- Erstellung einer Dokumentations-Roadmap 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 beim Durchführen von Dokumentenprüfungen
Freiwillige Helfer
Fordere Community-Mitglieder dazu auf, sich anzumelden, um bei bestimmten Aufgaben zu helfen. Beispiele:
- @JaneQCoder kann die Präsentation der Dokumentations-Roadmap in unserem Community-Meeting koordinieren.
Kontaktdaten
- Technische Autoren, die an diesem Projekt arbeiten möchten, sollten eine E-Mail an email@project/ein Problem senden oder in unserem Forum eine Frage stellen. Geben Sie Links zu Ihrer technischen Schreibarbeit oder Ihrem Portfolio/Lebenslauf an.
Weitere Informationen
- Die Werbe- und Presseseite enthält Logos und andere Inhalte, die Sie für die Präsentation von Google Season of Docs verwenden können.
- In diesem Video von PyCon Australia 2017 erhalten Sie Tipps dazu, wie Sie Ihre Dokumentation so organisieren, dass Nutzer sie nützlich finden: What nobody Audioinhalte von Dokumentation von Daniele Procida.