Aktuelle Phase:
Projektabschluss. Siehe Zeitachse.
Hier finden Sie einige Richtlinien, die Open-Source-Organisationen dabei helfen sollen, effektiv mit technischen Redakteuren zusammenzuarbeiten.
Den technischen Redakteur mit der Welt von Open Source und Ihrer Community vertraut machen
- Führen Sie den technischen Redakteur durch Ihre Community. Wo können sie Fragen stellen? An welchen regelmäßigen Treffen sollte er teilnehmen oder welchen Mailinglisten sollte er beitreten? Welche Konten benötigen sie (Github, Discord, Slack)? Achten Sie darauf, dass sie den Verhaltenskodex Ihres Projekts kennen und wissen, wie sie Probleme melden können. Achten Sie darauf, dass Ihr Technischer Redakteur die Lizenz Ihres Projekts kennt und alle Anforderungen anderer Arbeitgeber in Bezug auf die Unterzeichnung von Geheimhaltungsvereinbarungen, Dienstvertragsvereinbarungen oder anderen Vereinbarungen erfüllt.
- Stellen Sie ihm nach Möglichkeit einige Personen in Zeitzonen vor, die sich überschneiden und die schnell auf Fragen zur Community oder zum Projekt reagieren können.
- Wenn möglich, senden Sie ihnen etwas aus dem Projekt.
Helfen Sie dem technischen Redakteur, die Tools und Prozesse zu verwenden, die für die Mitarbeit an Ihrem Projekt erforderlich sind.
- Wenn Ihre Prozesse nicht gut dokumentiert sind, vereinbaren Sie einen Termin, um den technischen Redakteur durch seinen ersten Beitrag, sein Problem oder seinen Pull-Request zu führen. Welche Vorlagen oder Tags sollte er verwenden? Wer muss den Beitrag prüfen und wie und wann sollte er die Überprüfungen nachverfolgen? Wie können Codebeispiele getestet werden? Was muss er über Ihren CI/CD-Prozess oder Ihre Releases wissen?
Hilf dem technischen Redakteur, dein Projekt und seine Nutzer zu verstehen
- Beschreiben Sie Ihr Projekt ausführlich, damit der Technische Redakteur ein solides konzeptionelles Verständnis des Produkts erhält. Dies kann dem technischen Redakteur helfen, sich sicherer zu fühlen und bei der Erstellung der Projektdokumente mehr Autorität zu haben.
- Beschreiben Sie die Anforderungen der Nutzer des Projekts. Seien Sie so spezifisch wie möglich – nicht nur „Entwickler“, sondern „Entwickler, die Websites erstellen“ und „Entwickler, die Industrieroboter programmieren“.
- Stellen Sie den technischen Redakteur in Kontakt mit den erforderlichen Fachleuten. Das sind die Entwickler oder anderen Projektmitarbeiter, die für die Aspekte Ihres Projekts verantwortlich sind, die in der Dokumentation behandelt werden.
- Sorgen Sie dafür, dass die technischen Redakteure von den Fachleuten und anderen Community-Mitgliedern die Zeit und Ressourcen erhalten, die sie benötigen.
Stellen Sie Fragen.
- Ihre Community oder Ihr Projekt hat möglicherweise noch nie mit technischen Redakteuren oder Mitwirkenden an der Dokumentation zusammengearbeitet. Nutzen Sie die Gelegenheit, um etwas Neues zu lernen, während Sie Ihr Wissen teilen. Bitten Sie um Feedback zu Ihren Prozessen und Tools. Ihr Technischer Redakteur hat wahrscheinlich einige Verbesserungsvorschläge.