Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- I concetti di base di Linux
- Technical writer:
- xiaoya
- Nome progetto:
- Crea la documentazione per il progetto CHAOSS D&I Badging
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Inserisco i contenuti principali come segue: Gli obiettivi principali sono arricchire le opere correlate ai documenti all'interno del flusso di lavoro, scrivere una documentazione con badge D&I rivolta alla community e ospitare la documentazione elaborata in più lingue su una piattaforma specializzata, che può essere suddivisa nelle seguenti microattività: Aggiornare e integrare l'attuale modello di PR utilizzando più metriche D&I e diversificare le domande. Redigi una panoramica concettuale per introdurre il programma di badge D&I Redigere le linee guida dell'applicatore utilizzando i documenti JOSS come riferimento Preparare una bozza delle linee guida per i revisori utilizzando i documenti JOSS come riferimento Un documento che spieghi i diversi ruoli e le rispettive responsabilità durante il flusso di lavoro. Un documento che spiega come viene applicato il probot GitHub per il flusso di lavoro Una linea guida per i collaboratori per mostrare come un nuovo arrivato può contribuire al progetto o al documento. Aiutami con il lavoro di traduzione dei documenti, controlla le prestazioni della traduzione automatica, soprattutto in cinese, e favorisci la traduzione manuale, se necessario. Organizza la documentazione in un formato multilingue in base al lavoro di traduzione. Usa Gitbook, Leggi il documento o Wiki GitHub per ospitare il documento.
Risultato 1. Arricchisci il modello di PR del progetto e dell'evento con più metriche e domande eterogenee. Questo prodotto include tutto il lavoro relativo ai documenti all'interno del flusso di lavoro, in particolare il modello di PR preparato per il completamento dei candidati. Questo è ciò che penso sia il componente fondamentale del flusso di lavoro in quanto svolge un ruolo decisivo nella valutazione dei revisori, pertanto la forma e il contenuto delle domande verranno perfezionati durante la costruzione del flusso di lavoro e lo fornirò dai seguenti punti: Basare su diversi tipi di eventi o progetti Combinare le metriche con più diversità di proofing
Risultato 2. Di seguito è riportata una bozza di documentazione rivolta alla community
Panoramica del badge D&I per l'introduzione ai badge
Obiettivo
Livelli del badge
Richiedere un badge
Richiedere il badge dell'evento
Il modello PR dell'evento
Fare domanda per il badge del progetto
Il modello PR del progetto
Revisione
Come diventare revisore
Come diventare revisore
Come diventare revisore
Criteri di revisione dei conflitti di interesse D&I
Criteri di revisione
Revisione dei compiti e revisione dei PR
Risultato 3. Organizza i documenti in un formato multilingue e ospitali su piattaforme come Leggi i documenti o Gitbook.
Nel flusso di lavoro attuale, stiamo valutando alcune opere di traduzione automatica. Ti aiuterò a verificare l'efficacia del risultato della traduzione, in particolare in cinese, come la correttezza e la fluidità della traduzione. Il documento esisterà in un formato. Effettuerò accertamenti sulle piattaforme di hosting di documenti tecnici, come Read the docs, Gitbook e wiki GitHub, e sceglierò la piattaforma più adatta per ospitare la documentazione aperta rivolta alla community.