Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- A base do Linux
- Redator técnico:
- xiaoya (em inglês)
- Nome do projeto:
- Build Documentation for CHAOSS D&I Badging Project
- Duração do projeto:
- Duração padrão (três meses)
Project description
Eu coloco o conteúdo principal da seguinte forma: As principais metas são enriquecer os trabalhos relacionados a documentos no fluxo de trabalho, escrever uma documentação de selos de D&I voltada para a comunidade e hospedar a documentação processada em vários idiomas na plataforma especializada, que pode ser separada nas seguintes microtarefas: Atualizar e integrar o modelo de RP atual usando mais métricas de D&I e diversificar as perguntas. Escreva um resumo conceitual para apresentar o programa de selo de D&I Escreva as diretrizes para o solicitante usando os documentos do JOSS como referência Escreva as diretrizes para o revisor usando os documentos do JOSS como referência Um documento explicando diferentes funções e respectivas responsabilidades ao longo do fluxo de trabalho. Um documento explicando como o probot do GitHub é aplicado ao fluxo de trabalho Uma diretriz para colaboradores mostrando como um novato pode contribuir com o projeto ou o documento. Ajudar com a tradução de documentos, verificar o desempenho da tradução automática, especialmente em chinês, e fazer traduções manuais, se necessário. Organize a documentação em um formato multilíngue com base no trabalho de tradução. Use o Gitbook, o arquivo de leitura do documento ou o GitHub Wiki para hospedar o documento.
Resultado 1. Enriqueça o modelo de relações públicas do projeto e do evento com mais métricas e perguntas diversas. Este produto inclui todo o trabalho relacionado a documentos no fluxo de trabalho, principalmente o modelo de RP preparado para os candidatos preencherem. Esse é o componente principal do fluxo de trabalho, já que desempenha um papel decisivo na avaliação dos revisores. Portanto, a forma e o conteúdo das perguntas serão aperfeiçoados durante a construção do fluxo de trabalho, e eu vou entregar isso com base nos seguintes pontos: Com base em diferentes tipos de eventos ou projetos Combinando com mais métricas de D&I Usando várias maneiras de perguntas com respostas baseadas em provas
Resultado 2. Confira abaixo um rascunho da estrutura de documentação voltada à comunidade
Visão geral do selo de D&I
Introdução
Meta
Níveis de selo
Como solicitar um selo
Solicitar um selo de evento
Modelo de RP do evento
Solicitar um selo de projeto
Modelo de RP do projeto
Revisão
Como se tornar um revisor
Política de conflito de interesses do selo de D&I
Critérios de revisão
Lista de verificação de revisão
Funções e responsabilidades
Candidatos: criar RP
Revisores: revisar RP
Moderadores: analisar avaliações e atribuições de revisão
Mantenedor: verificação final e mesclagem de RP
Código de conduta do selo de D&I do Probot
Como contribuir
Resultado 3. Organize os documentos em vários idiomas e hospede-os em plataformas como o Read the docs ou o Gitbook.
No fluxo de trabalho atual, alguns trabalhos de tradução automática estão sendo explorados. Vou ajudar a verificar o resultado da tradução, especialmente em chinês, como a exatidão e a fluência da tradução. O documento vai existir como um formato. Vou investigar as plataformas de hospedagem de documentos técnicos, como Read the docs, Gitbook e GitHub wiki, e escolher a plataforma mais adequada para hospedar a documentação aberta para a comunidade.