Perguntas com a marcação «documentation»

18
Código de auto-documentação vs Javadocs?

Recentemente, tenho trabalhado na refatoração de partes da base de código com a qual estou lidando atualmente - não apenas para entender melhor, mas também para facilitar para outras pessoas que estão trabalhando no código. Costumo me apoiar no lado de pensar que o código de auto-documentação é...

18
O que você deve deixar para seus sucessores?

Suponha que você seja o único desenvolvedor a deixar um emprego. Que tipo de informação / material, fora do próprio código, você deve criar e deixar para sua substituição? Uma resposta óbvia é "o que você deseja em um novo emprego", com certeza, mas já faz um tempo desde que eu comecei um novo...

17
Qual padrão substituiu 830-1998?

Estive estudando como documentar projetos de software de maneira mais formal e aprendi sobre o IEEE 830-1998: Prática recomendada para especificações de requisitos de software . No entanto, como você pode ver nesse link, ele foi substituído. Eu sei que 830-1998, e provavelmente até 830-1993,...

15
O dizer "Objeto JSON" é redundante?

Se JSON significa JavaScript Object Notation, quando você diz JSON, não está realmente dizendo "JavaScript Object Notation Object"? Dizer "string JSON" seria mais correto? Ou seria mais correto simplesmente dizer JSON? (como em "Esses dois serviços transmitem JSON entre

15
Quanta documentação é suficiente?

Quanta documentação técnica (para futuros desenvolvedores) é suficiente ? Existe uma proporção entre horas de codificação e horas de documentação que é apropriada? Papadimoulis argumenta que você deveria produzir a menor quantidade de documentação necessária para facilitar o maior...

14
Como documentar um idioma ubíquo?

Nossa empresa está convertendo muitos processos manuais de negócios (e o conhecimento institucional associado) em novos softwares corporativos. O projeto está indo muito bem, mas, à medida que prosseguimos, fica claro que há muita confusão com relação a termos e definições, tanto no lado comercial...

14
Escrevendo casos de teste de aceitação

Estamos integrando um processo de teste em nosso processo SCRUM. Minha nova função é escrever testes de aceitação de nossos aplicativos da web para automatizá-los posteriormente. Eu li muito sobre como os casos de teste devem ser escritos, mas nenhum me deu conselhos práticos para escrever casos de...

13
Passando de um projeto individual para um projeto de equipe no futuro. O que devo fazer agora em preparação e o que pode esperar?

Para elaborar, estou interessado em saber o que as pessoas pensam que você precisa implementar enquanto ainda é um projeto individual (controle da fonte da equipe, documentação, compilação etc.) e o que as coisas não precisam ser feitas até que a segunda pessoa chegue. para o projeto. Qualquer...