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:
- 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 (3 meses)
Project description
Com a oportunidade de documentar a ferramenta de alertas da organização Moja Global, proponho o desenvolvimento de seis tipos de documentação que serão usados por diferentes públicos-alvo para alcançar diferentes finalidades. Elas são resumidas abaixo:
1) Guia de configuração do ambiente
1.1) Público-alvo: engenheiros de sistema
1.2) Objetivo Ajudar os engenheiros do sistema 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 descreve o conjunto de etapas sequenciais que os engenheiros de sistema devem seguir para configurar o ambiente que será adequado para a criação e execução da Ferramenta de Geração de relatórios.
2) Guia de criação
2.1) Público-alvo: engenheiros de sistema
2.2) Objetivo Ajudar engenheiros de sistemas a criar os componentes da ferramenta de relatórios a partir do código-fonte
2.3) Formatar um artigo de instruções que determina o conjunto de etapas sequenciais que os engenheiros de sistema devem seguir para receber e compilar o código-fonte da ferramenta de relatórios.
3) Guia de instalação
3.1) Público-alvo: engenheiros de sistema
3.2) Objetivo Ajudar engenheiros de sistema a instalar os novos componentes da Ferramenta de relatórios
3.3) Formatar um artigo de instruções que determina o conjunto de etapas sequenciais que os engenheiros de sistema devem seguir para implantar a ferramenta de relatórios em um ambiente recém-configurado.
4) Guia de operação
4.1) Integradores de sistema de público-alvo
4.2) Objetivo: ajudar os engenheiros do sistema a executar uma instância da ferramenta de relatórios recém-instalada
4.3) Formato Um artigo de instruções que determina o conjunto de etapas sequenciais que os Integradores de Sistemas precisam seguir para fazer upload e processar bancos de dados de saída de fluxo em uma instância da Ferramenta de relatórios em execução.
Guia de operação Integrar e processar bancos de dados de saída de fluxo 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 à Ferramenta de Geração de relatórios e como eles devem ser usados.
5.3) Formatar um Artigo de Instruções que determina o conjunto de etapas sequenciais que os Usuários Finais devem seguir para utilizar adequadamente as funcionalidades da Ferramenta de Geração de relatórios.
6) Guia de desenvolvimento
6.1) Programadores de público-alvo
6.2) Objetivo Ajudar os Usuários Finais a entender os diferentes recursos incorporados à Ferramenta de Geração de relatórios e como eles devem ser usados.
6.3) Formatar 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 decompostos funcionalmente; d) o código-fonte e a organização das bibliotecas da ferramenta e) a visão e a direção de longo prazo para 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