Mit einem technischen Redakteur zusammenarbeiten

Aktuelle Phase:
Die Saison 2019 für Google Docs wurde am 6. März 2020 beendet. Siehe Zeitachse.

Nachfolgend finden Sie einige Richtlinien für Open-Source-Organisationen zur Zusammenarbeit mit einem technischen Redakteur, dem Sie als Mentor für „Season of Docs“ fungieren:

  • Stellen Sie dem technischen Redakteur die Open-Source-Welt und Ihre Community vor.
  • Unterstützen Sie den technischen Redakteur dabei, die Tools und Prozesse zu verwenden, die für einen Beitrag zu Ihrem Projekt benötigt werden.
  • Erläutern Sie Ihr Produkt im Detail, damit der technische Redakteur ein solides Konzept des Produkts erhält. Dies kann dazu beitragen, dass die technische Redakteurin sich selbstbewusster fühlt und verlässlicher für das Projekt schreibt.
  • Beschreiben Sie die Bedürfnisse Ihrer Zielgruppe, also die Anforderungen der Entwickler, die Ihr Produkt verwenden, und/oder anderer Gruppen, die das Produkt verwenden.
  • Arbeiten Sie mit dem technischen Redakteur die wichtigen Anwendungsfälle zusammen, um die erforderliche Dokumentation zu entwerfen.
  • Gehen Sie den Code durch, wenn der technische Redakteur es verstehen muss, bevor Sie die Dokumente schreiben.
  • Den technischen Redakteur mit den entsprechenden Fachleuten in Kontakt bringen Das sind die Entwickler oder anderen Projektbeteiligten, die für die Aspekte Ihres Produkts verantwortlich sind, die in der Dokumentation behandelt werden.
  • Sicherstellen, dass der technische Redakteur die Zeit und die Ressourcen erhält, die er von den Fachleuten und anderen Community-Mitgliedern benötigt.
  • Arbeiten Sie mit dem technischen Redakteur zusammen, um den Dokumenten aussagekräftige Codebeispiele hinzuzufügen.

Hinweise

Open-Source-Mentoren in „Season of Docs“ sind nicht unbedingt technische Autoren. Die beratenden Personen müssen keine Dokumentationsfähigkeiten haben. Die technischen Redakteure bringen diese Fähigkeiten in das Projekt und die Mentoring-Beziehung ein.

Stattdessen bringen die Mentoren ihr Wissen über ihre Open-Source-Community, das Produkt sowie die Prozesse und Tools ein, die im Open-Source-Projekt verwendet werden.

Ein wichtiges Ergebnis der Mentoringbeziehung sollte darin bestehen, dass der technische Redakteur eine lohnenswerte und erfolgreiche Erfahrung in der diesjährigen Docs-Saison hat. Eine glückliche Erfahrung erhöht die Chancen, dass der technische Redakteur auch nach Ablauf der diesjährigen Docs-Saison noch einen Beitrag zum Open-Source-Projekt leisten wird und dass andere technische Redakteure sich für die Arbeit an Open Source begeistern.