Perguntas com a marcação «documentation»

Uma parte essencial do Design Orientado a Domínio é o uso consistente de uma linguagem onipresente em todo o sistema - em conversas, código, esquema de banco de dados, interface do usuário, testes, etc. Estou envolvido em um projeto no qual já existe uma linguagem de domínio bem estabelecida, definida …

10 documentation  domain-specific-languages 

Parece-me que você não pode escrever uma especificação de software em inglês completamente livre de ambiguidades, simplesmente devido à natureza informal da linguagem natural - e, portanto, que uma especificação verdadeiramente inequívoca deve incluir código escrito em uma linguagem formalmente especificada. Esse é um resultado conhecido ou estou faltando alguma …

10 documentation  specifications 

Sou um desses desenvolvedores que tem a mentalidade de que o código escrito deve ser auto-explicativo e lido como um livro. NO ENTANTO, ao desenvolver o código da biblioteca para outras pessoas, tento colocar o máximo de documentação possível nos arquivos de cabeçalho; o que levanta a questão: Os métodos …

10 c++  documentation 

É difícil dizer o que está sendo pedido aqui. Essa pergunta é ambígua, vaga, incompleta, excessivamente ampla ou retórica e não pode ser razoavelmente respondida em sua forma atual. Para obter ajuda para esclarecer esta questão para que possa ser reaberta, visite o centro de ajuda . Fechado há 8 …

10 agile  documentation  methodology 

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á 6 anos . Nosso software interno foi usado por muitos usuários e o departamento de treinamento …

10 design  documentation  users 

Documentei meu código doxygen, mas não quero o HTML padrão que ele fornece. Eu sei que posso personalizá-lo fornecendo CSS, cabeçalhos, rodapés personalizados etc. (como o GNOME faz), e como posso adicionar código PHP comum aos arquivos e pedir para que ele salve como .php, mas não é exatamente isso …

10 documentation  templates  documentation-generation 

Gostaria de saber o que deve conter uma documentação de algoritmo? Não é possível localizar uma orientação adequada a seguir. Eu tenho em mente incluir resumo do algoritmo descrição do algoritmo fluxogramas pseudo códigos conjunto de dados de entrada de amostra (múltiplo) dados de saída testes de unidade experimentos O …

10 java  php  algorithms  documentation  sql 

Temos muitos documentos associados ao nosso desenvolvimento de software. Isso inclui requisitos, documentos de design, PDFs externos, arquivos de clientes, instruções de teste etc. Atualmente, esses documentos estão espalhados por todo o lugar (wiki, "algum lugar na rede", um disco rígido local para desenvolvedores (!), e lugares ainda piores). Qual …

10 version-control  documentation 

Ao revisar a implementação de uma função de outro programador para calcular a CDF de distribuição normal , sugeri substituir a implementação inteira pelas funções internas do Python ou usar o SciPy, uma biblioteca científica comum. Outro programador apontou que math.erfc()nem scipy.stats.norm.cdf()fornece garantias de precisão em sua documentação. Portanto, eu …

9 documentation  math  floating-point  numeric-precision 

Muitas vezes, me pego resolvendo bugs encontrando a resposta no Stack Overflow. É uma má prática adicionar um trecho do motivo pelo qual fiz o que fiz e depois adicionar um link a um artigo ou página da Web?

9 documentation 

Estou trabalhando em uma pequena biblioteca que fornece implementações de métricas básicas e bem conhecidas de strings. Principalmente para minha própria educação. Assim, o desenvolvimento acontece sempre que tenho um pouco de tempo livre. Por isso, automatizei a maioria dos processos para poder lançar uma versão sempre que trabalhar nela …

9 java  documentation  javadocs 

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á 4 anos . Por que ainda incorporamos descrições em linguagem natural do código-fonte …

9 development-process  documentation  source-code 

Isso se refere a uma discussão em uma resposta e aos comentários desta pergunta: O que há com a aversão à documentação no setor? . A resposta alegou que "o código não pode mentir" e, portanto, deve ser o local de destino em vez da documentação. Vários comentários apontaram que …

9 documentation 

Estou prestes a sair de um projeto e, antes de partir, meu chefe me pediu para documentar o código (não o documentei muito bem). Não é grande coisa, o projeto não é terrivelmente complexo. Mas estou encontrando lugares em minha documentação onde gostaria de dizer: "Observe na linha XYZ que …

9 documentation  comments 

Estou interessado em ver como outras pessoas fazem isso. Especialmente em situações em que vários clientes diferentes estão usando a mesma base de software com regras de negócios ligeiramente diferentes. Que tipo de práticas você usa para documentar como tudo deve funcionar ou regras de negócios. Basicamente, quando um novo …

9 documentation  business-rules