Perguntas com a marcação «documentation»

Estou tentando documentar um software que escrevi em detalhes. Um SAS é muito alto e não cobre a API. Encontrei vários exemplos de um SDS online, mas não vejo uma tendência em seu formato. Gostaria de saber se existem algumas diretrizes gerais para escrever uma especificação de design de software …

8 documentation  api  uml  design 

Atualmente, estou trabalhando em uma implementação definida em JavaScript. Isso deve simular genéricos conhecidos como Java ou C #. Eu preciso de uma versão mutável disso (permite adicionar / remover valores definidos) e uma versão imutável. Minha assinatura do construtor é assim: new GenericSet( 'number', [ 10, 20, 30 ] …

8 javascript  documentation 

Qual seria uma boa alternativa para a documentação Java embutida, ou seja, é possível ter um arquivo de documentos separado de alguma forma mapeado para um arquivo de origem java? Eu nunca gostei de grandes seções de comentários repletas de código.

8 java  documentation  javadocs 

Atualmente, estou trabalhando em um projeto, no qual tenho que analisar os requisitos de dois sistemas de TI, que usam computação em nuvem, para uma API em nuvem. Em outras palavras, tenho que analisar quais requisitos esses sistemas têm para uma API de nuvem, para que eles possam trocá-la, enquanto …

8 documentation  api 

Eu sou novo no Django. Eu achei os guias oficiais de tópicos https://docs.djangoproject.com/en/1.3/ um excelente lugar para aprender. Mas agora estou em um local em que preciso de referência rápida para ver quais métodos um objeto tem, quais argumentos leva, o que retorna etc., como os documentos Python ou Java. …

8 django  documentation 

Fechado . Esta questão precisa ser mais focada . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela se concentre apenas em um problema editando esta postagem . Fechado há 2 anos . Estou no meio da co-produção de um documento de "abordagem …

8 development-process  documentation  team 

Você pode recomendar um bom modelo de plano de teste para uma equipe de testes ágil? Eu sei que existem modelos para testes na Web e já vi alguns encontrados pelos mecanismos de pesquisa, mas eu realmente poderia usar algo leve e algo que já foi testado por testadores qualificados …

8 testing  documentation 

Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 4 anos . Quão útil é medir pontos de função ? Usamos …

8 project-management  documentation 

Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 5 anos . Minha equipe herdou recentemente um projeto de uma equipe …

8 documentation  team  exception-handling  coding-style 

Fechadas. Esta questão está fora de tópico . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela esteja no tópico do Software Engineering Stack Exchange. Fechado há 4 anos . Recentemente, recebi a tarefa de criar um documento de plano de implementação. Quando …

8 project-management  documentation 

Um colega meu esteve em um seminário sobre desenvolvimento ágil, onde ouviu que é possível usar testes de unidade como documentação técnica. Algo como usar testes de unidade como um exemplo de como usar a classe. Uma rápida pesquisa no Google forneceu TDD e documentação , o que prova que …

8 agile  unit-testing  documentation  tdd 

Eu desenvolvi algumas bibliotecas quantitativas em C # onde é importante entender não apenas as informações clássicas que acompanham os comentários XMLDoc (que contêm informações básicas com a assinatura do método), mas também as fórmulas matemáticas usadas nos métodos. Por isso, gostaria de poder incluir documentação estendida com o código, …

8 documentation  documentation-generation 

Estou trabalhando em um relatório que precisa explicar em termos não técnicos os efeitos de um erro cumulativo e por que é importante usar cálculos absolutos. Definição de 'erro cumulativo' de dictionary.com : um erro que aumenta gradualmente em grau ou significância durante uma série de medições ou cálculos; um …

8 documentation  terminology  management