Perguntas com a marcação «documentation»

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, discute tecnologias XML que são centrais …

9 documentation  semantic-web  literate-programming 

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 documentação? Também devo documentar toda a …

9 documentation 

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 dessa maneira …

9 documentation  design  modeling 

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 situação ruim de ter muito pouca documentação …

9 documentation 

Eu quero escrever Javadoc de maneira SECA. Mas o documento da Oracle sobre Javadoc diz que escreva a mesma coisa novamente no comentário do método de sobrecarga. Não posso evitar a repetição?

9 documentation  comments  dry  javadocs 

Estou assumindo meu primeiro aplicativo de nível corporativo e quero que minha equipe modele todo o aplicativo ASP.NET MVC C # antes mesmo de digitar uma linha de código. ATUALIZAÇÃO: Esta não era uma discussão filosófica sobre quando documentar / modelar um aplicativo. Por favor, forneça apenas respostas para "como" …

9 c#  asp.net-mvc  documentation  uml 

Então, você está corrigindo erros e encontrou um que poderia afetar outros módulos do produto de software. Seus dados não são suficientes para apoiar sua reivindicação sobre os efeitos da correção e você foi solicitado a criar um documento de análise de impacto. Existe um processo definido sobre como fazer …

9 project-management  documentation 

Estou procurando maneiras de melhorar o gerenciamento de requisitos. Atualmente, temos um documento do Word publicado em um site. Infelizmente, não podemos (que eu saiba) analisar as alterações de uma revisão para a seguinte. Eu preferiria muito poder fazê-lo, muito parecido com um wiki ou VCS (ou ambos, como o …

9 documentation  project-management  wiki  requirements 

Esta pode ser uma pergunta estúpida, mas está na minha cabeça há um tempo e não consigo encontrar uma resposta decente em nenhum outro lugar. Eu tenho um professor que diz que devemos listar explicitamente cada parâmetro com uma descrição, mesmo se houver apenas um. Isso leva a muita repetição: …

9 documentation  comments  coding-style 

Alguém tem sugestões para criar uma representação de fluxograma de uma interface da web no estilo REST? No interesse de fornecer documentação completa para os co-desenvolvedores, eu tenho trabalhado na modelagem da interface para modificar e gerar um recurso do produto: Esse sistema em particular começa a agir de maneira …

9 documentation  rest  flowchart 

Sou desenvolvedor de software em uma empresa de tecnologia. Fui encarregado de liderar o esforço de documentação do produto em que trabalho. O objetivo é produzir documentação interna para o desenvolvedor, e o projeto se espalha para o lado comercial, onde abrange a documentação de requisitos. Este projeto é desafiador. …

9 development-process  documentation  teamwork  planning 

Acho que um dos maiores pontos negativos do trabalho com microsserviços é garantir que as APIs estejam bem documentadas e que as APIs não alterem seu comportamento sem afetar os aplicativos downstream. Esse problema se amplifica quando você tem muitos serviços que são interdependentes entre si. Talvez nesse momento você …

8 api-design  documentation  microservices 

Temos de 20 a 30 módulos / soluções independentes. Cada um deles tem cerca de 7 a 10 projetos com diferentes classes, componentes, etc. Estes são todos utilizados internamente em nossa empresa. Nosso problema é que, quando fazemos uma alteração em um módulo, precisamos garantir a atualização de todos os …

8 documentation  api  configuration-management  change-management 

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á 6 anos . Comecei a trabalhar em uma grande empresa de software …

8 documentation  refactoring  management  business  development-environment 

Criar uma biblioteca C ++ também significa documentá-la para que outros possam usá-la e essa documentação possa variar drasticamente em qualidade. Como um site para uma biblioteca C ++ deve ser estruturado para que seja mais eficaz? Eu descreveria o "mais eficaz" como sendo dividido entre três grupos específicos de …

8 c++  documentation