Eu completei um aplicativo Web que é basicamente desenvolvido em PHP e é apenas mais um aplicativo Web regular. Geralmente, quando entrego a versão final da produção, apenas entrego a documentação do código e as informações de arquitetura ao cliente. No entanto, para esse projeto em particular, o cliente insiste em ter os dados completos de entrada e saída do projeto.
Então, eu estou apenas pensando ... Quais são os documentos técnicos e não técnicos obrigatórios que posso fornecer ao meu cliente além das documentações de código e arquitetura?
(Além disso, seria muito legal entrar em contato com o cliente sobre várias estatísticas e dados sobre o projeto, para que ele realmente soubesse a quantidade de trabalho envolvido e o quão realmente legal o produto é.)
Respostas:
Eu acho que a lista deve incluir:
Nem todas essas coisas podem estar disponíveis (ou necessárias) para cada projeto, mas acho que este é um bom guia geral.
fonte
Além da resposta realmente boa do FrustratedWithFormsDesigner, gostaria de dizer o que incluem os documentos não técnicos (como fizemos):
a oferta que você fez:
que juntos atuam como uma espécie de contrato sobre o que você deve fazer e o que espera que
o cliente entregue durante o desenvolvimento, bem como o tempo e custo estimados.
a especificação, incluindo protocolos de revisão, casos de uso e planos de teste, resultados de teste
o design em UML e todos os documentos correspondentes
a documentação do código fonte (doxygen ou qualquer outra coisa)
as diretrizes de manual e instalação
a quantidade real final de recursos (tempo e dinheiro) usados para o projeto, para que você possa escrever uma fatura
alguns clientes também desejam os protocolos de reunião, o que é uma extensão do "documento de decisões" mencionado acima
Espero que seja isso que você estava procurando.
fonte
Siga a documentação que se aplica ao seu projeto, a seguir: Você já pode ter algumas delas.
Documentação técnica:
Prepare documentos com capturas de tela e destaque o código relevante (se necessário) para o seguinte:
Insira dados inválidos e mostre que é impossível fazer isso, pois você realizou a validação de dados no front-end e no back-end.
/* This step is not applicable if you have not used any object for getting direct input from the user like Text Field as it is obvious that you cannot get invalid data through indirect input. */
Mostre que não há erro no programa ou inconsistência nos dados se houver uma falha repentina no servidor ou no sistema cliente, explicando o código relevante.
Você deve verificá-las antes de documentá-las, para que, se seu cliente solicitar uma demonstração com dados de amostra, você possa mostrar como o projeto realmente funciona. Além disso, verifique se o código do front-end possui linhas de comentário apropriadas.
Finalmente, conclua com as estatísticas, como número total de linhas de código, número total de dias passados para o projeto, número total de vezes que você verificou o projeto, uma lista de todos os aplicativos utilizados e outras informações técnicas e não técnicas.
Documentação não técnica:
fonte
Seja cauteloso
A documentação potencial que você poderia fornecer ao cliente é praticamente infinita. O tempo adicional necessário para gerar a documentação que você ainda não possui não é remunerado.
Por que o cliente deseja esta documentação (além do código-fonte)? O que será feito com isso? para quem é isso?
As respostas a essas perguntas ajudarão a limitar o escopo do que entregar.
É fundamental que você e o cliente concordem exatamente sobre qual documentação entregar e se algum esforço adicional será compensado.
Não jogue jogos de adivinhação. A maior parte da documentação técnica seria inútil para o cliente típico (não técnico).
fonte
Eu provavelmente dividiria isso em algumas categorias de documentos:
Guias:
Apoio, suporte:
Pontos de integração:
fonte