O que são especificações técnicas? Eles são iguais aos documentos de design. Caso contrário, qual é a diferença e alguns
Trabalho como parte de uma equipe em um aplicativo existente que não possui documentação em linha nem documentação técnica. Enquanto eu trabalhava em vários relatórios de bugs no aplicativo, escrevi uma espécie de trilha de trilha para mim - números de bugs em vários lugares para que o próximo...
Minha empresa está procurando melhorar o gerenciamento de dados de pesquisa de mercado. Estilo de gerenciamento de dados atual: "Hey Jimbo, onde está a foto do nosso WhatZit 2.0? "Sim, eu lembro daquele email sobre essa empresa daquele cara, me dê alguns minutos para pesquisar no meu...
Estamos tentando mover nosso processo de documentação do projeto do Google Documents para um conjunto de repositórios Git auto-hospedados. Os documentos de texto são compatíveis com o Git, já que geralmente não precisamos de nenhuma formatação sofisticada, apenas converteremos tudo em, por...
Atualmente, sou estagiário em uma empresa contratada pelo governo e estou tendo a sensação (irritantemente inevitável) de que o Word é o padrão de fato no processo de desenvolvimento de software. Seu formato binário dificulta muito a colaboração em documentos da maneira como estou acostumado a...
Quando as pessoas começaram a escrever arquivos Leia-me? Parece que praticamente todos os programas possuem esse arquivo, independentemente do formato. Existe algum primeiro uso documentado deste
Existem alguns bons exemplos de códigos bem documentados, como o java api. Porém, muitos códigos em projetos públicos, como o git e os projetos internos das empresas, são mal documentados e pouco amigáveis para os iniciantes. Em todas as minhas etapas de desenvolvimento de software, tive que...
No meu local de trabalho, enfrentamos um desafio em que "ágil" com muita frequência significa "requisitos vagos, critérios de aceitação ruins, boa sorte!" Estamos tentando resolver isso, como um esforço geral de melhoria. Portanto, como parte disso, proponho que geremos documentos de design que,...
O Desenvolvimento Orientado a Comportamentos, com sua sintaxe dos cenários emblemáticos "Dado quando", ultimamente tem sido bastante elogiado por seus possíveis usos como um objeto de limite para a avaliação da funcionalidade do software. Concordo definitivamente que o Gherkin , ou o script de...
Por que a documentação em alguns idiomas diz "equivalente a" em vez de "é"? Por exemplo, os documentos do Python dizem itertools.chain(*iterables) ... Equivalente a: def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield...
Estou trabalhando em um projeto há alguns anos e estou começando a reunir uma base de usuários decente. Criei uma página de projeto com alguma documentação básica, mas, na verdade, não é muito mais que uma FAQ neste momento. Sei que preciso aprimorá-lo para torná-lo mais informativo para usuários...
Não consigo contar o número de vezes que leio declarações na veia de 'testes de unidade são uma fonte muito importante de documentação do código em teste'. Não nego que sejam verdadeiras. Mas, pessoalmente, nunca me vi usando-os como documentação. Para as estruturas típicas que eu uso, as...
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 no ano passado . Desejo...
Parece um assunto controverso documentar tudo, incluindo a sintaxe "JavaBean" de getters e setters para campos: as pessoas dizem que é DRY desnecessariamente longo e repetitivo (não se repita) , que a convenção de nomenclatura deve explicar tudo , e confunde código / documentação. Às vezes, esses...
No momento, estamos escrevendo especificações funcionais e técnicas em um formato de duas colunas; frase sumária e detalhes técnicos. Os detalhes geralmente se referem a um apêndice com diagramas, desenhos de layout etc. No entanto, estou lutando com que tensão para escrevê-lo: No passado, como...
Antecedentes: Meus colaboradores e eu estamos escrevendo um artigo para uma revista acadêmica. No decorrer de nossa pesquisa, escrevemos um programa de simulação em Java. Queremos tornar o programa de simulação disponível gratuitamente para uso de outras pessoas. Decidimos hospedar o código em um...
Então nós temos uma interface assim /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff ///...
Às vezes, embora não frequentemente, tenho que incluir lógica matemática no meu código. Os conceitos usados são geralmente muito simples, mas o código resultante não é - muitas variáveis com objetivos pouco claros e algumas operações com intenções não tão óbvias. Não quero dizer que o código...
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 . Depois de...
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 é...