Aktuelle Phase:
Ankündigung der Ergebnisse
Zeitplan.
Im Folgenden finden Sie einige Richtlinien, die Ihnen dabei helfen sollen, Open-Source-Organisationen effektiv mit technischen Redakteuren zusammenzuarbeiten.
Stellen Sie dem technischen Redakteur die Open-Source-Welt und Ihre Community vor.
- Biete dem technischen Redakteur eine Tour durch deine Community. Wo können sie Fragen stellen? An welchen regulären Meetings sollte er teilnehmen oder an welchen Mailinglisten sollte er teilnehmen? Welche Konten benötigt sie (GitHub, Discord, Slack)? Stellen Sie sicher, dass sie den Verhaltenskodex Ihres Projekts verstehen und wissen, wie Probleme gemeldet werden können. Stellen Sie sicher, dass Ihr technischer Redakteur die Lizenz für Ihr Projekt kennt und alle Anforderungen anderer Arbeitgeber in Bezug auf die Unterzeichnung von CLAs, DCOs oder anderen Vereinbarungen einhält.
- Stellen Sie sie nach Möglichkeit einigen Personen in sich überschneidenden Zeitzonen vor, die schnell auf Fragen zur Community oder zum Projekt antworten können.
- Sende ihnen, wenn möglich, Projektgeschenke!
Helfen Sie dem technischen Redakteur dabei, die Tools und Prozesse zu nutzen, die für einen Beitrag zu Ihrem Projekt benötigt werden.
- Wenn Ihre Prozesse nicht gut dokumentiert sind, vereinbaren Sie einen Termin, an dem der technische Redakteur durch den ersten Beitrag, das erste Problem oder die erste Pull-Anfrage geführt wird. Welche Vorlagen oder Tags sollte sie verwenden? Wer muss seine Beiträge überprüfen, und wie und wann sollten Rezensionen erfolgen? Wie können sie getestet werden, wenn ihre Arbeit Codebeispiele enthält? Was muss sie über Ihren CI/CD-Prozess oder Ihre Releases wissen?
Helfen Sie dem technischen Redakteur, Ihr Projekt und seine Nutzenden zu verstehen.
- Erläutern Sie Ihr Projekt im Detail, damit die technische Redakteurin ein solides konzeptionelles Verständnis des Produkts erlangt. Dies kann dazu beitragen, dass sich der technische Redakteur sicherer fühlt und verlässlicher für das Projekt schreibt.
- Die Bedürfnisse der Personen beschreiben, die das Projekt nutzen. Seien Sie so konkret wie möglich – nicht nur „Entwickler“, sondern auch „Entwickler, die Websites erstellen“ und „Entwickler, die Industrieroboter programmieren“.
- Den technischen Redakteur mit den entsprechenden Fachleuten in Kontakt bringen Das sind die Entwickelnden oder anderen Projektbeteiligten, die für die Aspekte Ihres Projekts 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.
Stellen Sie Fragen!
- Ihre Community oder Ihr Projekt hat möglicherweise noch nicht mit technischen Redakteuren oder Mitwirkenden an der Dokumentation zusammengearbeitet. Nutzen Sie diese Gelegenheit und teilen Sie Ihr Wissen mit anderen. Bitten Sie um Feedback zu Ihren Prozessen und Tools – Ihr technischer Redakteur wird wahrscheinlich einige Verbesserungsvorschläge machen.