Aktuelle Phase:
Fallstudien wurden veröffentlicht. Siehe Zeitachse.
Auf dieser Seite finden Sie einige Fragen, die Sie sich stellen sollten, wenn Sie eine Vereinbarung mit einem technischen Redakteur für Google Season of Docs treffen. Dies ist keine Rechtsberatung und keine vollständige Liste aller möglichen Punkte, die beim Erstellen von technischen schriftlichen Vereinbarungen für Open-Source-Projekte zu berücksichtigen sind. Je nach den Anforderungen Ihrer Organisation oder Ihres Projekts sollten Sie sich vor dem Onboarding eines technischen Redakteurs an Ihren Rechtsbeistand wenden.
Umfang der Tätigkeit
- Erstellen Sie eine Liste der Arbeiten, die von Ihrer Vereinbarung abgedeckt sind. Machen Sie dabei möglichst genaue Angaben. Erstellen Sie beispielsweise anstelle von „API-Dokumentation“ eine Liste der Endpunkte, die dokumentiert werden müssen, und der Informationen, die enthalten sein müssen, z. B. ein Beispiel-Curl-Befehl oder eine Liste von Parametern.
- Woran erkenne ich, dass ein Inhalt fertig ist?
- Weitere Hinweise:
- Wer ist der Inhaber des Urheberrechts an dem Werk? Unter welcher Lizenz wird es veröffentlicht (diese unterscheiden sich)? Welche Anerkennung erhält der Technische Redakteur (Erwähnung auf der Website, Nennung als Mitwirkender usw.)? Was ist, wenn die Inhalte in Zukunft neu lizenziert werden müssen? Wenn Sie beispielsweise erwarten, dass der Technische Redakteur die Contributor License Agreement Ihres Open-Source-Projekts unterzeichnet, sollten Sie dies mitteilen.
- Wenn Sie davon ausgehen, dass der Technische Redakteur an mehreren Überarbeitungsdurchgängen teilnehmen soll, geben Sie diese an. Sie können beispielsweise angeben, dass Sie einen ersten Entwurf, dann einen zweiten Durchlauf zur Behebung technischer Probleme und dann einen abschließenden Durchlauf zur Korrekturlesen erwarten.
- Wenn Sie erwarten, dass der Technische Redakteur Inhalte in einem bestimmten Format liefert, z. B. Markdown, nehmen Sie dies in Ihre Vereinbarung auf.
- Gibt es für Ihr Projekt Richtlinien für die Verwendung generativer KI zum Erstellen von Dokumentation oder Code? Teilen Sie diese Richtlinien mit Ihrem technischen Redakteur.
Vergütung
- Vereinbaren Sie mit dem technischen Redakteur einen Zahlungsplan, der an feste Termine und Liefergegenstände gebunden ist.
- Zahlen Sie zu Beginn der Arbeit einen Vorschuss?
- Was passiert, wenn die Arbeit nicht verwendet oder akzeptiert werden kann (z. B. weil sich die Prioritäten des Projekts geändert haben oder ein Prüfer ausgestiegen ist)? Können Sie eine „Kill-Fee“ zahlen, um die Zeit des technischen Redakteurs zu kompensieren?
- Wer ist für die Währungsumrechnungsgebühren verantwortlich, die im Zusammenhang mit der ausgewählten Zahlungsmethode anfallen?
Kommunikation
- Erwarten Sie, dass der Technische Redakteur für Videoanrufe oder Besprechungen verfügbar ist?
- Welche Kommunikationskanäle verwenden Sie und wie lange dauert es voraussichtlich, bis Sie eine Antwort erhalten? Wenn Sie beispielsweise erwarten, dass ein Technischer Redakteur innerhalb eines Tages auf E-Mails (oder Nachrichten in Slack) antwortet, sollten Sie dies ausdrücklich erwähnen.
- An wen im Projekt kann sich der Technische Redakteur bei verschiedenen Fragen wenden, z. B. bei Zahlungsproblemen, bei Bedarf einer Überprüfung, bei Problemen mit Tools oder Kanälen oder bei anderen Blockaden?
- Gibt es einen bestimmten Prozess, den der Autor beim Einreichen seiner Arbeit oder beim Einholen von Feedback oder Rezensionen verwenden sollte?
Tools
- Welche Tools (oder Versionen von Tools) muss der Technische Redakteur verwenden, um seine Arbeit zu erstellen?
- Wer ist dafür verantwortlich, dem technischen Redakteur bei der Einrichtung, beim Zugriff oder bei der Berechtigung zu helfen?
Unstimmigkeiten beheben
- Wie gehen Sie mit Meinungsverschiedenheiten über die Qualität der Arbeit des technischen Redakteurs um? Wer hat das letzte Wort?
- Wie wird der Technische Redakteur aus dem Projekt entlassen? Das kann beispielsweise der Fall sein, wenn Sie drei Termine in Folge verpassen oder Arbeit in nicht akzeptabler Qualität einreichen. Wenn Sie den Prozess durchsetzen, sollten Sie die nächsten Schritte klar formulieren („Wir erwarten bis nächsten Freitag einen Pull-Request für den ersten Entwurf“, anstatt „Bitte reichen Sie Ihre Arbeit so bald wie möglich ein.“).
- Wie sollte ein Technischer Redakteur mitteilen, dass er aus dem Projekt aussteigen muss? Sollten sie möglichst eine Benachrichtigung senden, ein Übergabedokument erstellen oder einen Übergabeanruf führen?
- Berücksichtigen Sie auch die Verpflichtungen des Projekts gegenüber dem technischen Redakteur. Wenn Ihre Projektmentoren beispielsweise aussteigen und nicht ersetzt werden können oder versprochene Rezensionen nicht abgeschlossen werden können, sollten Sie dem technischen Redakteur einen Teil der verbleibenden Gelder zahlen, auch wenn das Projekt nicht abgeschlossen werden kann, um ihn für seine Zeit zu entschädigen.
- Geben Sie ausdrücklich an, dass der technische Redakteur an den Verhaltenskodex des Projekts gebunden ist, und verlinken Sie auf den Prozess zur Durchsetzung des Verhaltenskodexes. Sie können angeben, dass Verstöße gegen die Nutzungsbedingungen zur Kündigung des Projekts und zum Verlust der Zahlung für ausstehende Arbeit führen.