Fase attuale:
Sviluppo della documentazione. Consulta la cronologia.
Questa pagina contiene alcune domande da considerare durante la creazione di un contratto con uno scrittore tecnico per la stagione di Documenti Google. Questo non è inteso come una consulenza legale o come un elenco esaustivo di tutti i possibili punti da considerare durante la creazione di contratti di scrittura tecnici 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 Technical Writer.
Ambito del lavoro
- Crea un elenco dei lavori coperti dal contratto. Fornisci una descrizione il più dettagliata possibile. Ad esempio, anziché "Documentazione API", crea un elenco degli endpoint da documentare e delle informazioni che devono essere incluse, come un comando curl di esempio o un elenco di parametri.
- Come fai a sapere se un contenuto è "finito"?
- Altri aspetti da considerare:
- Chi sarà il titolare del copyright dell'opera? Quale licenza verrà rilasciata secondo (sono diverse)? Che merito riceverà l'autore tecnico (menzione sul sito, nome del collaboratore ecc.)? E se in futuro i contenuti dovessero essere rilicenza in futuro? Ad esempio, se prevedi che il Technical Writer firmi il Contratto di licenza dei collaboratori del tuo progetto open source, devi comunicarlo.
- Se prevedi che il Technical Writer partecipi a più pass di revisione, indicalo. Ad esempio, potresti indicare che ti aspetti una prima bozza, poi un secondo passaggio per risolvere problemi tecnici e infine un ultimo passaggio per la correzione di bozze.
- Se prevedi che il Technical Writer pubblichi contenuti in un formato specifico, ad esempio Markdown, includilo nel contratto.
- Il tuo progetto prevede linee guida per l'uso dell'IA generativa per la creazione di documentazione o codice? Assicurati che queste linee guida siano condivise con il tuo Technical Writer.
Retribuzione
- Concordare con il Technical Writer un calendario dei pagamenti legato a date fisse e materiali finali.
- Dovrai pagare un importo iniziale all'inizio del lavoro?
- Cosa succede se il lavoro non può essere utilizzato o accettato (perché le priorità del progetto sono cambiate o perché un revisore ha abbandonato e così via)? Puoi pagare un "costo per l'uccisione" per compensare il tempo speso dal redattore tecnico?
- Chi sarà responsabile di eventuali commissioni di conversione di valuta relative al metodo di pagamento scelto?
Comunicazione
- Ti aspetti che il Technical Writer sia disponibile per le videochiamate o le riunioni?
- Quali sono i canali di comunicazione che utilizzerai e quali sono i tempi di risposta previsti? Ad esempio, se prevedi che un Technical Writer risponda alle email (o ai messaggi in Slack) entro un giorno, indicalo in modo esplicito.
- Chi del progetto può contattare il Technical Writer per varie domande, ad esempio per problemi di pagamento, necessità di una revisione, problemi con gli strumenti o i canali o altri blocchi?
- Esiste una procedura specifica che l'autore dovrebbe utilizzare per inviare il proprio lavoro o ricevere feedback o recensioni?
Strumenti
- Quali strumenti (o versioni) deve utilizzare il Technical writer 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?
- Quale sarebbe la procedura per rilasciare il Technical Writer dal progetto? Ad esempio, mancare tre scadenze consecutive o consegnare lavori di qualità inaccettabile. Quando applichi la procedura, valuta la possibilità di indicare in modo esplicito i passaggi successivi ("Prevediamo che venga inviata una richiesta di pull per la prima bozza entro venerdì prossimo" invece di "Invia il tuo lavoro il prima possibile").
- Se un Technical Writer deve abbandonare la procedura, come dovrebbe comunicarlo? Se possibile, il cliente deve avvisare, creare un documento di trasferimento o effettuare una chiamata?
- Non dimenticare di considerare gli obblighi del progetto nei confronti del Technical Writer. Ad esempio, se i mentori del tuo progetto rinunciano 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 Technical Writer anche se il progetto non può essere completato, per compensare l'autore del tempo dedicato.
- Dichiarare esplicitamente che il Technical Writer è vincolato dal Codice di condotta del progetto e inserire un link alla procedura di applicazione del Codice di condotta. È opportuno chiarire che le violazioni del CdC comporteranno la chiusura del progetto e la perdita del pagamento per qualsiasi lavoro in sospeso.