Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- La piattaforma Linux
- Redattore tecnico:
- xiaoya
- Nome del progetto:
- Documentazione per la creazione del progetto di certificazione D&I di CHAOSS
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Ho inserito i contenuti principali nel seguente documento: Gli obiettivi principali sono arricchire i lavori relativi ai documenti all'interno del flusso di lavoro, scrivere una documentazione sui badge D&I rivolta alla community e ospitare la documentazione elaborata in più lingue sulla piattaforma di specializzazione, che può essere suddivisa nelle seguenti micro attività: Aggiorna e integra il modello PR attuale nell'utilizzo di più metriche D&I e diversifica le domande. Prepara una bozza di panoramica concettuale per presentare il programma di certificazione per l'inclusione e la diversità Prepara una bozza delle linee guida per gli utenti che presentano domanda di certificazione utilizzando i documenti JOSS come riferimento Prepara una bozza delle linee guida per i revisori utilizzando i documenti JOSS come riferimento Un documento che spiega i diversi ruoli e le rispettive responsabilità durante il flusso di lavoro. Un documento che spiega come viene applicato il probot di GitHub per il flusso di lavoro Una linea guida per i collaboratori per mostrare in che modo un utente nuovo può contribuire al progetto o al documento. Aiutare con la traduzione dei documenti, controllare il rendimento della traduzione automatica, in particolare in cinese, ed eseguire traduzioni manuali, se necessario. Organizza la documentazione in un formato multilingue in base al lavoro di traduzione. Utilizza Gitbook, Read the Doc o la Wiki di GitHub per ospitare il documento.
Deliverable 1. Arricchisci il modello di PR del progetto e dell'evento con più metriche e domande diverse. Questo deliverable include tutto il lavoro relativo ai documenti all'interno del flusso di lavoro, in particolare il modello di RP preparato per i richiedenti da compilare. Questo è, a mio avviso, il componente principale del flusso di lavoro in quanto svolge un ruolo decisivo nella valutazione dei revisori, pertanto la forma e i contenuti delle domande verranno perfezionati durante la costruzione del flusso di lavoro e li presenterò nei seguenti punti: In base a diversi tipi di eventi o progetti In combinazione con altre metriche di D&I Utilizzo di diversi tipi di domande con richieste di risposte basate su prove
Deliverable 2. Di seguito è riportata una bozza della struttura della documentazione rivolta alla community
Panoramica dei badge per la diversità e l'inclusione
Introduzione
Obiettivo
Livelli dei badge
Richiesta di un badge
Richiedi il badge per l'evento
Il modello di RP per l'evento
Richiedi il badge per il progetto
Il modello di RP per il progetto
Revisione
Come diventare un revisore
Norme relative ai conflitti di interesse per i badge per la diversità e l'inclusione
Criteri di revisione
Elenco di controllo della revisione
Ruoli e responsabilità
Chiedistelleri: crea RP
Revisori: rivedi RP
Moderatori: dai un'occhiata alle revisioni e alle assegnazioni delle revisioni
Amministratore: controllo finale e unione RP
Probot
Codice di condotta per i badge per la diversità e l'inclusione
Come contribuire
Risultati finali 3. Organizza i documenti in un formato multilingue e ospitali su piattaforme come Read the docs o Gitbook.
Nel flusso di lavoro attuale, stiamo esplorando alcuni lavori di traduzione automatica. Ti aiuterò a verificare l'efficacia del risultato della traduzione, in particolare in cinese, ad esempio la correttezza e la fluidità della traduzione. Il documento esisterà come formato. Esaminerò le piattaforme di hosting della documentazione tecnica come Read the Docs, Gitbook e la wiki di GitHub e sceglierò la piattaforma più adatta per ospitare la documentazione aperta rivolta alla community.