Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Linux Foundation
- Redator técnico:
- xiaoya (em inglês)
- Nome do projeto:
- Criar documentação para o projeto de selo CHAOSS D&I
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Coloquei o conteúdo principal no seguinte: Os principais objetivos 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 Rascunhos e experimentos e diversas perguntas. Elabore uma visão geral conceitual para apresentar o programa de selos D&I Elabore as diretrizes do aplicador usando os documentos do JOSS como referência Elabore as diretrizes do revisor usando os documentos do JOSS como referência Um documento que explica as diferentes funções e as respectivas responsabilidades ao longo do fluxo de trabalho. Um documento explicando como o GitHub Probot é aplicado ao fluxo de trabalho. Uma diretriz de colaborador para mostrar como um iniciante pode contribuir com o projeto ou o documento. Ajuda com a tradução de documentos, verifica o desempenho da tradução automática, principalmente em chinês, e faz traduções manuais, se necessário. Organizar a documentação em um formato multilíngue com base no trabalho de tradução. Use o Gitbook, o Leia o documento ou o Wiki do GitHub para hospedar o documento.
Resultado 1. Enriqueça o modelo de RP do projeto e do evento com mais métricas e perguntas diversas. Essa entrega inclui todo o trabalho relacionado a documentos no fluxo de trabalho, especialmente o modelo de RP preparado para os candidatos. Acho que é o principal componente do fluxo de trabalho, porque desempenha um papel decisivo na avaliação de revisores, de modo que a forma e o conteúdo das perguntas sejam perfeitos ao longo da construção do fluxo de trabalho.
Resultado 2.
Veja abaixo um rascunho da estrutura de documentação voltada à comunidade
Visão geral dos selos D&I
Introdução
Meta
Níveis de selo
Inscrever-se para receber um selo
Inscrever-se para receber o selo do evento
O modelo de RP do evento
Inscrever-se para o selo do projeto
O modelo de RP do projeto
Revisão
Como se tornar um revisor
D&I Badging Conflito de interesses
Analisar critérios
Analisar lista de verificação Papéis e responsabilidades
Revisão dos colaboradores e responsabilidades
Resultado 3. Organize os documentos em um formato multilíngue 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 analisados. Vou ajudar a verificar o desempenho da tradução, especialmente em chinês, como a precisão e a fluência da tradução. O documento existe como um formato. Vou investigar as plataformas técnicas de hospedagem de documentos, como o Read the docs, o Gitbook e o wiki do GitHub, e escolher a plataforma mais adequada para hospedar a documentação aberta da comunidade.