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:
- moja global
- Redator técnico:
- Anthony
- Nome do projeto:
- Documentação do código da ferramenta de relatórios
- Duração do projeto:
- Duração padrão (três meses)
Project description
Tendo a oportunidade de documentar a ferramenta de relatórios para a organização Moja Global, proponho desenvolver seis tipos de documentação que serão utilizados por públicos diferentes para finalidades diferentes. Eles são resumidos abaixo:
1) Guia de configuração do ambiente
1.1) Engenheiros de sistemas de público-alvo
1.2) Objetivo Ajudar os engenheiros de sistemas a configurar um ambiente local de criação e execução para a ferramenta de relatórios.
1.3) Formato Um artigo de instruções que determina o conjunto de etapas sequenciais que os engenheiros de sistemas precisam seguir para configurar o ambiente adequado para a criação e execução da Ferramenta de relatórios.
2) Guia de criação
2.1) Engenheiros de sistemas de público-alvo
2.2) Objetivo Ajudar os engenheiros de sistema a criar os componentes da ferramenta de relatórios com base no código-fonte
2.3) Formato Um artigo de instruções que prescreve o conjunto de etapas sequenciais que os engenheiros de sistema precisam seguir para acessar e compilar o código-fonte da ferramenta de relatórios.
3) Guia de instalação
3.1) Público-alvo Engenheiros de sistemas
3.2) Objetivo Ajudar os engenheiros de sistema a instalar componentes recém-criados da ferramenta de relatórios
3.3) Formato Um artigo de instruções que determina o conjunto de etapas sequenciais que os engenheiros de sistemas precisam seguir para implantar a ferramenta de relatórios em um ambiente recém-configurado.
4) Guia de operação
4.1) Público-alvo Integradores de sistemas
4.2) Objetivo Ajudar os engenheiros de sistema a executar uma instância recém-instalada da ferramenta de relatórios
4.3) Formato Um artigo de instruções que descreve o conjunto de etapas sequenciais que os integradores de sistemas precisam seguir para fazer upload e processar bancos de dados de saída do Flux em uma instância da ferramenta de relatórios em execução.
Guia de operação: integre e processe os bancos de dados de saída do Flux na ferramenta de relatórios
5) Guia do usuário
5.1) Público-alvo Usuários finais
5.2) Objetivo Ajudar os usuários finais a entender os diferentes recursos incorporados na ferramenta de relatórios e como eles devem ser usados.
5.3) Formato Um artigo de instruções que prescreve o conjunto de etapas sequenciais que os usuários finais precisam seguir para usar corretamente as funcionalidades da ferramenta de relatórios.
6) Guia de desenvolvimento
6.1) Público-alvo Programadores
6.2) Objetivo Ajude os usuários finais a entender os diferentes recursos incorporados na ferramenta de relatórios e como eles devem ser usados.
6.3) Format Artigos de referência que descrevem: a) os principais elementos de design que compõem a ferramenta b) a decomposição funcional dos elementos acima c) os elementos de execução dos elementos funcionalmente decompostos d) a organização do código-fonte / das bibliotecas da ferramenta e) a visão de longo prazo e a direção para a melhoria contínua f) as próximas áreas lógicas para melhoria
E um breve tutorial que descreve como o código pode ser ajustado para circunstâncias específicas do usuário