Guida dell'amministratore dell'organizzazione

Fase attuale:
Risultati annunciati tempistiche.

Questa guida è destinata agli amministratori di organizzazioni che richiedono o partecipano al programma Stagione dei documenti.

La tua organizzazione deve partecipare al programma Season of Docs?

Utilizza queste domande per capire se il tuo progetto o la tua organizzazione open source deve partecipare a Season of Docs.

La tua organizzazione o il tuo progetto:

  • Ritieni che una documentazione nuova o aggiornata aiuterebbe a raggiungere un obiettivo o risolvere un problema nel tuo progetto o nella tua community?
  • Hai una comprensione iniziale o un'ipotesi su come misurare il successo del tuo progetto di documentazione?
  • Hai membri della community disposti ad aiutare a reclutare, valutare e inserire un Technical Writer e chi sarebbe disponibile per rispondere alle domande e fornire ulteriore supporto durante il progetto (6-8 mesi, compreso il periodo di candidatura)?
  • Hai un membro della community disposto a ricoprire il ruolo di amministratore dell'organizzazione e a coordinare la creazione della candidatura, rispondere alle domande degli amministratori del programma e inviare valutazioni mensili, nonché la valutazione finale e il case study? L'amministratore dell'organizzazione deve inoltre essere disponibile a rispondere ai sondaggi di follow-up al termine del programma Season of Docs (Stagione dei documenti).

La tua organizzazione deve inoltre soddisfare i requisiti di idoneità del programma, tra cui la possibilità di creare un account Open Collective.

Il processo di richiesta dell'organizzazione

Fase di esplorazione

Anche se le domande per la stagione dei documenti apriranno il 23 febbraio 2022, consigliamo vivamente alle organizzazioni di completare i passaggi della fase di esplorazione prima di inviare la domanda.

  • Crea la pagina di una proposta per il progetto. La pagina della proposta include un elenco di esigenze, obiettivi o problemi chiave, possibili soluzioni di documentazione e possibili metriche. Questa pagina deve essere pubblica e consentire la partecipazione e la discussione della community. Includi informazioni per i tecnici che desiderano partecipare, dove dovrebbero porre domande, esprimere interesse o scoprire di più sul tuo progetto? Ti suggeriamo di aggiungere un indirizzo email per contattare la tua organizzazione open source in merito alla stagione di Documenti. Tuttavia, sconsigliamo vivamente di utilizzare un indirizzo email personale come indirizzo email per contattare la tua organizzazione open source. (Consulta l'elenco di idee per i progetti per alcuni esempi.)
  • Pubblicizza la pagina della proposta nei canali della community e aggiungi la tua organizzazione all'elenco delle organizzazioni interessate nel repository GitHub Stagione di Documenti. Puoi anche condividere il link nel canale #season-of-docs nel sito Write The Docs Slack. La pagina della promozione e della stampa include loghi e altri contenuti che puoi utilizzare quando si parla della stagione dei documenti.
  • Per ogni idea relativa alla documentazione, pensa a quale esperienza e quali qualifiche un Technical Writer deve avere per lavorare con successo con la tua comunità e la tua organizzazione. Quali competenze la tua community potrebbe aiutare a sviluppare un Technical Writer (ad esempio, utilizzando GitHub o la tua Toolchain per i documenti)? Consulta la guida per lavorare con i Technical Writer.
  • Chiedi a volontari di aiutarti a rispondere alle domande dei Technical Writer interessati.
  • Inizia a esaminare le dichiarazioni di interesse inviate da revisori tecnici interessati a lavorare con il tuo progetto.

Fase di richiesta

  • Scegli l'idea più promettente dalla pagina della proposta. Ogni organizzazione può presentare una sola proposta. Alcuni aspetti da considerare:
    • Quale idea ha suscitato l'interesse maggiore da parte dei Technical Writer?
    • Quale idea ti aiuterà a risolvere il problema maggiore del tuo progetto? È meglio scegliere un'idea più rischiosa che abbia un impatto maggiore rispetto a un'idea per un progetto di documentazione che ha maggiori probabilità di essere completato, ma che non farà una differenza significativa per il tuo progetto.
    • L'idea richiede la partecipazione di membri specifici della tua community? Hanno tempo per partecipare?

  • Crea la tua proposta utilizzando il modello di proposta. Assicurati di comprendere e includere:

    • Il problema da risolvere
    • L'ambito della documentazione che vuoi migliorare o creare
    • Come misurerai l'efficacia della documentazione

    La proposta deve includere anche un budget. Le proposte incomplete non verranno prese in considerazione.

  • Invia il modulo di candidatura entro la scadenza del 25 marzo 2022 alle 18:00 UTC. Le proposte accettate verranno annunciate il 14 aprile 2022.

Sviluppo dei progetti e generazione di report

Avvio del progetto

  • Se la tua organizzazione ha già selezionato un Technical Writer o un Writer per il tuo progetto, organizza una riunione introduttiva con il tuo Technical Writer. Collabora con il tuo Technical Writer per creare un programma per il lavoro e i controlli regolari.
  • Se hai ricevuto più dichiarazioni di interesse da parte di Technical Writer interessati, annuncia al pubblico la tua scelta di Technical writer oppure informa i candidati della tua decisione.

Concedi pagamenti

  • La stagione di Documenti verserà il 40% dei fondi di sovvenzione nell'account Open Collective di ciascuna organizzazione dopo l'assunzione di un Technical Writer, a partire dal 9 giugno 2022. Consigliamo alle organizzazioni di creare un programma di pagamento con i Technical Writer in base agli obiettivi del progetto, incluso il pagamento all'inizio del progetto.
  • Il restante 60% verrà depositato sugli account Open Collective delle organizzazioni che completano e inviano le valutazioni finali e i case study, a partire dal 14 dicembre 2022. Tieni presente che tutti i progetti riusciti, indipendentemente dalle tempistiche di completamento (ad es. un progetto di 3 mesi o 6 mesi), inizieranno a ricevere il pagamento finale il 14 dicembre 2022.
  • Consulta la guida ai pagamenti per ulteriori informazioni sulla creazione di un account Open Collective.

Report sullo stato del progetto

  • Gli amministratori dell'organizzazione devono compilare i rapporti di stato mensili entro una settimana dalla ricezione del link al modulo del rapporto di stato (il link verrà inviato via email, quindi controlla la cartella dello spam).

Valutazione finale del progetto e case study

Per ricevere i fondi rimanenti della sovvenzione, le organizzazioni devono completare e inviare sia la valutazione finale del progetto sia il case study prima del 30 novembre 2022 alle 18:00 UTC.

Valutazione finale

Il modulo di valutazione finale sarà disponibile per gli amministratori dell'organizzazione almeno un mese prima delle 18:00 UTC del 30 novembre 2022.

Case study

Il case study Season of Docs è il documento principale per la partecipazione della tua organizzazione a Season of Docs. Tenere un diario settimanale degli aggiornamenti del progetto ti aiuterà a creare il tuo case study. Per ogni settimana, registra l'avanzamento del progetto (compresi link a richieste di pull, problemi o conversazioni, se utili), ciò che è andato bene (o meno bene), ciò che hai imparato e le domande che sono state poste.

Per ulteriori informazioni, leggi Creazione di un case study e assicurati di seguire il nostro modello di case study per creare il tuo case study. Invierai il tuo case study sotto forma di link nel modulo di valutazione finale.

Il tuo case study verrà pubblicato sul sito Season of Docs, quindi tienilo presente quando includi le informazioni sul tuo progetto.

Chiediamo alle organizzazioni di partecipare ad almeno tre sondaggi di follow-up per poter monitorare il successo dei progetti della stagione dei documenti nel tempo.

Forms

Modulo Collegamento Scadenza
Applicazione dell'organizzazione

Le candidature dell'organizzazione sono chiuse. Iscriviti alla mailing list di season-of-docs-announce per non perderti le novità.

 25 marzo 2022 alle 18:00 UTC
Dati di pagamento dell'organizzazione

Questo modulo non è ancora disponibile.

 12 maggio 2022 alle 18:00 UTC
Documento attestante l'assunzione di un Technical Writer

Fase di assunzione del Technical Writer completata.

 16 maggio 2022 alle 18:00 UTC
Valutazioni mensili

La fase di valutazione mensile è terminata.

 Visualizza la cronologia
Valutazione finale del progetto e case study

La fase di valutazione del progetto è terminata.

 30 novembre 2022 alle 18:00 UTC
Sondaggi di follow-up

Modulo disponibile durante la fase dei sondaggi di follow-up (2 maggio 2023).

 Visualizza la cronologia