Documentação do software

JavaBaby Membro desde: 21/11/2010 19:41:55 Mensagens: 80 Offline

Ola galera, estou precisando da opinião de vocês.

Vou começar a fazer um sistema, porem estou com duvida a respeito da documentação.

- Quais sao os documentos necessários para o inicio da documentação, a questão do caso de uso e diagramas
- Quais são os documentos que devo passar para o cliente no momento da aquisição do software (lembrando que o cliente vai apenas alugar o sistema)
- Como devo proceder com o contrato para a aquisição do sistema
- Como eu registro o meu sistema, para ter direitos sobre ele
- Outro ponto que vários programadores iniciantes devem ter duvidas é a respeito do quanto cobrar, esta também é uma duvida minha

Estou perguntando varias coisas, já procurei bastante nos sites, peguei vários modelos, porem gostaria de ouvir a opinião de vocês, pois a maioria já trabalha na área.

Gostaria de algo bem profissional, que realmente as empresas utilizam, e não o que os professores passam para a gente na faculdade ou cursos. Por favor, se alguém tiver algum modelo dessa documentação, me passem para eu analisar, muito obrigado.

Quem tiver dicas também, por favor postem ai, blz.

Muitíssimo Obrigado!!!

This message was edited 1 time. Last update was at 31/01/2012 20:28:15

gustavotorquato wrote:
- Quais sao os documentos necessários para o inicio da documentação, a questão do caso de uso e diagramas

Papel e caneta, levantando os requisitos do sistema. Caso voce encontre algo complicado, voce pode fazer alguma diagramacao que te auxilie a "enxergar" a melhor solucao. Evite perder tempo tentando aprender ferramentas para este tipo de trabalho, normalmente elas nao te retornam o tempo investido em aprende-las.

Entao, nao se preocupe em documentar tudo, documento o que é necessario. Facil dizer, nao eh? Ok, vamos ao que eu ACHO necessario. Documentacao tecnica so em casos em que a complexidade de alguma funcionalidade seja muito alta e voce realmente precise de alguma informacao visual pra te ajudar a entender. Por exemplo quando múltiplas threads tem que passar pelo mesmo ponto de um sistema modificando o estado de N objetos (só um exemplo esdruxulo pra enfatizar) a tal ponto que se torna difícil de voce mapear de cabeca todas as possiblidades.

Do contrario, fuja. Imagine voce com um diagrama uml de um processo de producao de algum material, e nessa uml estarao todas as possibilidades, os ifs e elses, for e while e etc... Vai ficar um documento terrivel que nao serve pra nada, o tempo investido nele foi jogado fora e ele vai estar desatualizado a partira da primeira vez que voce precisar alterar e resolver (e vai) mudar direto o codigo. E pior, ainda que alguem leia e entenda o que aquele monte de uml quer dizer, ainda assim a pessoa vai precisar depois ler e entender o que o código faz. Documentacao tecnica é um caso classico da mesma informacao em dois lugares diferentes. Vai chegar um momento no tempo e no espaco em que estarao fora de sincronia. Isso nao quer dizer que voce nao possa desenhar alguma coisa no que se basear enquanto imagina o que faz, so nao gaste muito tempo documentando e nem se prenda ao documento, se ele comecar a te atrapalhar jogue fora.

Documentacao tecnica eh a mais pura perda de tempo. Mas... pior ainda que perder tempo escrevendo documentacao tecnica é perder tempo tendo que ler o código para descobrir uma regra de negocio. As regras de negocio de uma aplicacao tem que estar documentadas, de preferencia em bom portugues, para que eu possa olhar o codigo e saber se ele esta fazendo aquilo que deveria, se esta de acordo ou nao, e nunca ter que olhar para descobrir o que ele faz. O que um codigo faz um documento vai me dizer, como ele faz so ele mesmo pode me dizer.

gustavotorquato wrote:
- Quais são os documentos que devo passar para o cliente no momento da aquisição do software (lembrando que o cliente vai apenas alugar o sistema)

Os que ele solicitar, se nao solicitar nada, um bom manual de uso do sistema vai ser muito util.

gustavotorquato wrote:
- Como devo proceder com o contrato para a aquisição do sistema

Procure um advogado. Serio, nao brinque com esse ponto para evitar dores de cabeca. Lembre que se voce for contratado para desenvolver um software por alguem, e nao houver nada estipulado em contrato quanto aos direitos comerciais sobre o software, ele é automaticamente desse alguem que te contratou. Entao procure um advogado.

gustavotorquato wrote:
- Como eu registro o meu sistema, para ter direitos sobre ele

Mesmo caso do anterior.

gustavotorquato wrote:
- Outro ponto que vários programadores iniciantes devem ter duvidas é a respeito do quanto cobrar, esta também é uma duvida minha

Isto depende de diversos fatores. Mas lembre-se de que normalmente voce vai trabalhar semanas (ate meses a fio dependendo do projeto), o cliente vai te ligar, se algo der errado voce vai ter que resolver, seja a hora que for do jeito que for e normalmente nao vai ter pra quem chorar. É so voce, aquela mensagem de erro e o google. Entao, tome muito cuidado com os "miliquinhentos real" que se o projeto durar quatro meses voce vai estar ganhando menos de 400/mes. Nesse caso, compre uma maquina de cortar grama e saia pela vizinhanca que voce ganha mais e se incomoda menos.

"Supimpa" YvGa

Papel de pão FTW!

Só complementando: baby steps, pequenos releases. É um sistema de anúncios? Faça o cadastro de usuários, veja funcionando, depois faça o cadastro de anúncios, relacione-os, coloque regras e por aí vai...entregue ALGO e SEMPRE. Feedbacks adiantados irão ajudar e muito.

HelloWorld Membro desde: 24/01/2012 21:00:37 Mensagens: 10 Offline

Dicas bem uteis do YvGa

YvGa wrote:

gustavotorquato wrote:

gustavotorquato wrote:
- Outro ponto que vários programadores iniciantes devem ter duvidas é a respeito do quanto cobrar, esta também é uma duvida minha

Isto depende de diversos fatores. Mas lembre-se de que normalmente voce vai trabalhar semanas (ate meses a fio dependendo do projeto), o cliente vai te ligar, se algo der errado voce vai ter que resolver, seja a hora que for do jeito que for e normalmente nao vai ter pra quem chorar. É so voce, aquela mensagem de erro e o google. Entao, tome muito cuidado com os "miliquinhentos real" que se o projeto durar quatro meses voce vai estar ganhando menos de 400/mes. Nesse caso, compre uma maquina de cortar grama e saia pela vizinhanca que voce ganha mais e se incomoda menos.

Enfase nisso. Tava aqui falando com um conhecido esses dias, depois de cortar o gramado, pensando se era mais vantagem por cimento logo em cima de tudo ou saia mais barato pagar um "leke" pra cortar a grama de veze em quando. Ae me falaram que o preço aqui ta por volta de 100 reais o corte - sim o corte.

Fiquei tentado.

JavaBaby Membro desde: 21/11/2010 19:41:55 Mensagens: 80 Offline

YvGa, cara, você falou tudo!!!, muito obrigado pelas respostas. Seguinte, o sistema que vou desenvolver é voltado para a areá de leilão presencial, já conheço um pouco dos processos de negocio, então estou elaborando uma documentação prévia de como poderia ser o sistema para apresentar para o cliente neste sábado, a respeito do preço, vou pensar bem, pois como você falou, os miliquinhentos é um problema!!!, kkkkk.

De qualquer forma, muito obrigado pela explicação, é sempre bom a gente ouvir opiniões de varias pessoas, e principalmente no meu caso que não tenho muita experiencia na área.

Mais uma vez, MUITO OBRIGADO!!!!

Notícias, artigos e o maior fórum brasileiro sobre Java