Documentação de um projeto VsScripter
- Luciano César Ascari
A documentação de um projeto em VsScripter é obrigatória. A ideia é que a informação da documentação seja bem clara e objetiva, com o intuito de auxiliar quem for responsável por avaliar códigos existentes e até mesmo o suporte interno das empresas ou o suporte Viasoft em caso de dúvidas do motivo pelo qual foi implementado determinada personalização.
Ao tentar salvar pela primeira vez um determinado projeto VsScripter, caso ainda não informada alguma documentação, a tela de cadastro de documentação é apresentada em tela para que o usuário informe dados relevantes sobre o projeto em desenvolvimento..
A documentação pode também ser acessada pelo menu “Project”, opção “Documentação”. Para auxiliar na descrição da documentação, o usuário pode na tela de documentação, clicar em “Usar template”, através dessa opção o sistema passa a fazer algumas perguntas que com a resposta do usuário passa a elaborar o texto final da documentação.
Segue a tela modelo de documentação:
