Fase attuale:
Case study pubblicati. Consulta la cronologia.
Questa pagina contiene alcune domande da considerare quando crei un contratto con un autore tecnico per la Stagione dei documenti di Google. Non si tratta di una consulenza legale o di un elenco esaustivo di tutti i possibili punti da considerare durante la creazione di contratti di scrittura tecnica per progetti open source. A seconda delle esigenze della tua organizzazione o del tuo progetto, ti consigliamo di rivolgerti al tuo consulente legale prima di iniziare a collaborare con un autore tecnico.
Ambito dei lavori
- Crea un elenco del lavoro coperto dal contratto. Fornisci informazioni quanto più specifiche possibile. Ad esempio, anziché "Documentazione API", crea un elenco degli endpoint da documentare e delle informazioni da includere, ad esempio un comando curl di esempio o un elenco di parametri.
- Come faccio a sapere se un contenuto è "terminato"?
- Altri aspetti da considerare:
- Chi possiederà il copyright dell'opera? Con quale licenza verrà rilasciato (sono diverse)? Quale credito riceverà il Technical Writer (menzione sul sito, elencato come collaboratore e così via)? Che cosa succede se i contenuti devono essere nuovamente concessi in licenza in futuro? Ad esempio, se prevedi che il tecnico redattore debba firmare il Contratto di licenza per i collaboratori del tuo progetto open source, devi comunicarglielo.
- Se prevedi che il tecnico della scrittura partecipi a più passaggi di revisione, indicali. Ad esempio, puoi indicare che prevedi una prima bozza, una seconda revisione per risolvere i problemi tecnici e una revisione finale.
- Se ti aspetti che il tecnico della scrittura fornisca i contenuti in un formato specifico, come Markdown, includilo nel contratto.
- Il tuo progetto ha linee guida per l'utilizzo dell'IA generativa per la creazione di documentazione o codice? Assicurati che queste linee guida vengano condivise con il tuo autore tecnico.
Compensazione
- Accordati con il Technical Writer su una pianificazione dei pagamenti legata a date e deliverables definiti.
- Pagherai un importo anticipato all'inizio del lavoro?
- Cosa succede se il lavoro non può essere utilizzato o accettato (ad esempio perché le priorità del progetto sono cambiate o perché un revisore si è ritirato e così via)? Puoi pagare una "commissione di annullamento" per compensare il tempo impiegato dal tecnico della scrittura?
- Chi sarà responsabile di eventuali commissioni di conversione valutaria relative al metodo di pagamento scelto?
Comunicazione
- Ti aspetti che il Technical Writer sia disponibile per videochiamate o riunioni?
- Quali canali di comunicazione utilizzerai e quali sono i tempi di risposta previsti? Ad esempio, se ti aspetti che un autore tecnico risponda alle email (o ai messaggi in Slack) entro un giorno, indicalo esplicitamente.
- Chi del progetto può essere contattato dal Technical Writer per diverse domande, come problemi di pagamento, necessità di revisione, problemi di sblocco di strumenti o canali o altri elementi che bloccano l'avanzamento?
- Esiste una procedura specifica che lo scrittore deve seguire per inviare il proprio lavoro o per ottenere feedback o recensioni?
Strumenti
- Quali strumenti (o versioni di strumenti) deve utilizzare il tecnico per la documentazione per creare il suo lavoro?
- Chi è responsabile di aiutare il Technical Writer a eseguire la configurazione, ottenere l'accesso o le autorizzazioni?
Risolvere i disaccordi
- Come risolverai i disaccordi sulla qualità del lavoro del Technical Writer? Chi ha l'ultima parola?
- Qual è la procedura per svincolare il tecnico della documentazione dal progetto? Ad esempio, non rispettare tre scadenze consecutive o consegnare lavori di qualità inaccettabile. Quando applichi la procedura, ti consigliamo di indicare esplicitamente i passaggi successivi ("Prevediamo che entro venerdì prossimo venga inviata una richiesta pull per la prima bozza" anziché "Invia il tuo lavoro il prima possibile").
- Se un autore tecnico deve ritirarsi, come deve comunicarlo? Se possibile, deve dare un preavviso, creare un documento di trasferimento o effettuare una chiamata di trasferimento?
- Non dimenticare di prendere in considerazione le obbligazioni del progetto nei confronti dello scrittore tecnico. Ad esempio, se i mentor del progetto si ritirano e non possono essere sostituiti o se le revisioni promesse non possono essere completate, valuta la possibilità di pagare una parte dei fondi rimanenti al tecnico scrittore anche se il progetto non può essere completato, per compensare il suo tempo.
- Indica esplicitamente che il redattore tecnico è vincolato dal Codice di condotta del progetto e fornisci un link alla procedura di applicazione del Codice di condotta. Ti consigliamo di chiarire che le violazioni del Codice di condotta comporteranno la risoluzione del progetto e la perdita del pagamento per qualsiasi lavoro in sospeso.