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 . Estamos em uma...
Se eu tenho um pedaço de código que é matematicamente ou estruturalmente bastante complexo e irredutível, como eu documentaria esse pedaço de código? Em particular, como posso garantir que alguém que não possua as habilidades matemáticas ou arquitetônicas que eu possuo possa entendê-lo na...
Eu estava (casualmente) pesquisando abordagens semânticas / ontológicas da documentação técnica, quando me deparei com essa gema : A programação alfabetizada e a Web Semântica são idéias de diferentes épocas, que têm uma conexão. O artigo vinculado Literate Programming in XML, de Norman Walsh,...
Primeiro, percebo que essa pergunta pode ser um tanto longa e vaga e peço desculpas por isso. Provavelmente, este é um problema básico com um nome abreviado para qualquer pessoa que "entenda", mas, como me falto a esse respeito, tenha paciência comigo ao descrever o problema. Faço programação...
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...
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 isso e...
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 "o código pode...
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...
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...
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...
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
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...
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 é...
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...
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...
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 isso é...
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...
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
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(...
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...