Ainda não tem acesso? Estude com a gente! Matricule-se
Ainda não tem acesso? Estude com a gente! Matricule-se

Solucionado (ver solução)

Desenvolvedor Autônomo: Qual a documentação de um Site ?

Oi !

Eu estive pensando esses temos, dentro da área de front-end ao desenvolver um site, existe toda uma documentação pesada, análise de requisitos, análise de riscos como quando se desenvolve um software ?

Tive esse conteúdo por vários semestre em Ciência da Computação mas como não me interessei por desenvolver software e parti para a web, gostaria de saber sobre a documentação ao se fazer um site para o cliente. Creio eu que em um desenvolvimento para uma empresa essa tarefa seja enviada para um especialista ? Mas e quando se desenvolve por conta própria ?

2 respostas

Fala aí Denis, tudo bem? Bom, geralmente eu já peguei trabalhos freelances para fazer por conta, ou seja, fora da empresa onde trabalho.

A documentação que eu fiz foi basicamente um contrato referente ao serviço á ser prestado.

No contrato eu descrevi todas as features, requisitos, valores e formas de pagamento.

Espero ter ajudado.

solução

A resposta depende do perfil do cliente.

Para um cliente menos exigente, a documentação poderia ser:

1 - Como usar o admin do site (por exemplo, se você criar um site com Wordpress, como o cliente pode adicionar novos conteúdos) 2 - Como o cliente pode instalar o site em outro servidor.

Geralmente, o item 1 acaba sendo o mais comum.

Os layouts de exemplo (JPGs) que você vai enviar antes de criar o site, também são um exemplo de documentação.

O contrato, conforme o professor citou acima, também serve como documentação do site, já que você vai detalhar as features que estão sendo contratadas.

A coisa fica mais exigente quando o seu cliente é uma agência, ou seja, você é um terceirizado que monta o site em nome de outra pessoa.

Neste caso, dependendo de sua área de atuação (frontend, backend, fullstack), as documentações poderiam ser:

1 - Wireframe (layout)

2 - Diagrama de entidades e relacionamentos (banco de dados)

3 - Dicionário de dados (banco de dados)

4 - Testes unitários (programação)

Dependendo do nível de exigência, pode até ser necessário entregar o site e o ambiente usados no desenvolvimento prontos para deploy no servidor do cliente (Ex: Docker)

Como você viu, para trabalhar por conta diretamente para o cliente final, a documentação seria menor :-)