Documentação para consulta de desenvolvedores

Bom dia,

Sou iniciante no scriptcase, por isso não sei se alguém já deu sugestão parecida, se sim, peço perdão.

Onde trabalho formamos equipes para desenvolver projetos e com tempo outras pessoas podem ter que fazer manutenção nos projetos e até mesmo os criadores podem não lembrar rapidamente de algumas coisas de projetos que não são atualizados a algum tempo.

Acho que seria interessante haver possibilidade dentro do projeto de criar uma pasta separada só para armazenarmos arquivos com informações de configurações e documentação tanto para consulta de quem desenvolveu quanto para novos membros de equipe. Ex:

  • armazenar imagem com os rascunhos do projeto do banco de dados.
  • arquivo de imagem de diagramas UML.
  • arquivo de imagem de fluxogramas, pra quem ainda usa.
  • arquivos de texto com informações de senha de administrador para acessar o sistema depois de pronto.
  • arquivo com rascunhos de layout de telas e relatórios.
  • cópia de atas de reunião com os usuários para definir assuntos relacionados ao sistema, para poder justificar alguma coisa que foi feita ou alterada.

E qualquer outro tipo de arquivo que seja necessário os desenvolvedores consultar. E é claro, esses arquivos não seriam incluídos nos arquivos de publicação do projeto.

Discordo.

Crie um projeto para gestão do seu desenvolvimento, ou baixe gratuito na web.

1 Curtida

Normalmente em empresas de software grandes, eles usam isso de maneira separada. Existem sistema de gestão de aplicativos próprios para isso. Por exemplo, existe o Confluence da Atlasian que é muito utilizado. Outro legal de utilizar para salvar documentações especificas do seu software é o GitBook, ele é bom também para criar documentação para usuário final…

Existem diversas ferramentas boas no mercado para isso. Muitas são pagas, porém, valem a pena dependendo do tamanho da sua equipe.

1 Curtida