Na atividade de Documentação devem ser gerados os documentos necessários para o produto, de forma que o cliente possa instalá-lo, entender a sua forma de utilização e conhecer as novidades do release.

 DOCUMENTAÇÃO OBRIGATÓRIA

Documentação - Desenvolvimento Padrão





Documento Técnico: utilizado para documentar as novas implementações, melhorias e correções importantes de cada requisito, seja ele para versões de roadmap ou distintas. Estão disponíveis em dois modelos de templates Documento Técnico Estendido e Documento Técnico Simplificado.

  • Em alguns casos, não é necessária a criação do Documento Técnico. São eles:
    • Itens agrupados por afinidade (itens com o mesmo assunto podem ser agrupados e gerar-se uma única documentação. É importante que seja mantida a rastreabilidade de onde essa documentação foi elaborada);
    • Ajuste em acentuação/correção ortográfica no sistema;
    • Programas de Acerto de Base;
    • Issues que foram registrados durante Teste Sistêmico.

  • Linha RM: É utilizada uma automação via robô de expedição para geração do release notes de manutenções em substituição ao Documento Técnico, onde é documentado de forma automatizada o que foi liberado na Release por Patch e por Produto. (Ex.: Release 12.1.23).

    • Informações que devem ser apresentadas ao cliente: a rotina ajustada, o ticket e a issue relacionada, o texto de descrição do check-in no TFS e os arquivos que foram modificados;
    • Importante que algum membro da equipe fique responsável por receber a notificação de criação das páginas quando o robô expedir, para que este fique responsável por auditar uma amostra das páginas criadas e publicá-las, para que as tornem visíveis aos clientes.

Quando elaborar o Documento Técnico?


Documento de Referência: apresenta os principais procedimentos realizados nos produtos TOTVS, com o objetivo de orientar o cliente na execução das suas rotinas diárias. É
composto pela ambientação, que expõe os itens de uso geral em todo o produto e as demais pastas que correspondem ao módulo, com um documento para cada programa. Este artefato deve ser gerado ou revisado de acordo com a necessidade.

Quando elaborar o Documento de Referência?



Documentação - Desenvolvimento Mobile




Guia de uso: No desenvolvimento Mobile as informações do Documento Técnico e de Referência podem estar documentadas em um único documento, o Guia de Uso, que deverá conter informações técnicas e dados de configuração, para que o cliente consiga instalar e utilizar o aplicativo.

Política de Privacidade: Para publicação de um aplicativo é preciso respeitar os itens definidos como obrigatórios pelas stores (Google Play/App Store) e também utilizar a versão da Política de Privacidade em vigência, que previamente foi validada pela área Jurídica da TOTVS. Template Política de Privacidade

Qualquer informação atrelada ao conteúdo do aplicativo precisa estar de acordo com a Política de privacidade, a versão disponibilizada pelo Jurídico não deve ter o seu conteúdo alterado, caso tenha dúvidas, abra um ticket para: [email protected].

*Para as equipes que disponibilizam aplicativos no Portal de Mobilidade ou semelhante, a Política de Privacidade não é necessária.

 DOCUMENTAÇÃO OPCIONAL

Documento de Integração: Descreve os pré-requisitos para a implantação e utilização de determinado módulo que apresenta integração com um ERP e Parceiros. Este artefato é opcional e deve ser criado por ofertas para os requisitos de integração.
É elaborado por um integrante do Dev Team na atividade Codificação em Processo de Desenvolvimento Ágil | Desenvolvimento. Após elaboração, o documento deve ser submetido à aprovação e, na sequência, enviado para revisão ortográfica.

Instrução de Trabalho - Documento de Integração

Instrução de Trabalho - Boas Práticas de Documentação

Instrução de Trabalho - Estrutura de Pastas (Documentação)


Vídeo How To: são pílulas de conhecimento em formato de vídeo, utilizadas para disseminar os processos TOTVS para área de Atendimento, áreas interessadas e Clientes. Estes vídeos tem duração máxima de 3 minutos, e quando necessário demonstrar processos mais complexos, deve-se gravar vídeos separados, para serem exibidos em sequência no YouTube. Este artefato não é obrigatório. No entanto, pode ser criado para todos os itens de inovação e para manutenções relevantes. Para acessar o tutorial e artefatos necessários para criar um How To pelo Camtasia, acessem o link.

Instrução de Trabalho - Como criar Vídeos How to?

Se necessário realizar a tradução da documentação, ver tópico "Tradução de Documentação de Produto ou Sistêmica".

____________________________________________________________________________________________________________________________________________________________________________________________________


     ENTRADA(S):

     ENVOLVIDO(S):

     SAÍDA(S):

  • Documento Técnico elaborado

  • Documento de Referência elaborado (quando necessário)
  • How To elaborado (opcional)
  • Task Board atualizado
  • Indicadores Operacionais atualizados

____________________________________________________________________________________________________________________________________________________________________________________________________

* Obrigatório


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.expand-control-text {
    color: #000000;
	font-size: 15px !important;
	font-weight:bold !important;
}

.expand-icon, .aui-icon, .aui-icon-small, .aui-iconfont-chevron-right {
    color: #FF8000;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
hr {
    border-bottom: 1px solid #FF8000;
}
</style>