Perguntas com a marcação «documentation»

Um dos principais objetivos das empresas de desenvolvimento de software é aumentar o fator Bus. Isso também é defendido em uma palestra organizada pelo Google . Isso significa que você deve codificar e documentar tudo de forma que, se você for atropelado no ônibus amanhã, o projeto ainda possa continuar. …

48 documentation  clean-code 

Parece haver aversão a escrever até a documentação mais básica. Nosso projeto READMEs é relativamente vazio. Não existem listas de dependências atualizadas nos documentos. Existe algo que eu não conheço no setor que faz com que os programadores não gostem de escrever documentação? Posso digitar parágrafos de documentos, se necessário, …

47 documentation  teamwork 

Ao trabalhar no código, enfrento muitos dos mesmos desafios que meus colegas de equipe, e escrevi algumas funções e classes úteis, e eles também. Se houver uma boa comunicação, ouvirei falar de algo maravilhoso que alguém montou e, seis meses depois, quando precisar, talvez me lembre e chame essa função, …

43 documentation  teamwork  team  code-reuse 

Eu me pego escrevendo (espero) comentários úteis na documentação de código (C ++) do tipo: The reason we are doing this is... A razão pela qual eu uso "nós" em vez de "eu" é porque faço muita escrita acadêmica onde "nós" é frequentemente preferido. Então aqui está a pergunta. Existe …

41 documentation 

O programa de CS da minha escola evita qualquer menção à programação orientada a objetos, por isso tenho lido algumas coisas sozinho para complementá-la - especificamente, Construção de Software Orientada a Objetos , de Bertrand Meyer. Meyer defende repetidamente que as classes devem ocultar o máximo de informações possível sobre …

39 design  object-oriented  documentation  performance 

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 exemplos?

38 documentation  specifications 

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 exemplo, multimarkdown com a opção de incorporar o …

35 version-control  documentation  tools  linux 

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 Outlook" "quem tem …

35 documentation  cms  wiki 

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 desenvolvedor …

35 documentation  language-agnostic  methodology 

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 colaborar em uma base …

33 development-process  documentation 

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 documento?

32 documentation  terminology  history 

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 lidar com códigos …

26 programming-practices  development-process  documentation  source-code  sdlc 

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, acima e além do nível da …

25 design  agile  documentation 

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 definição de recurso que você preferir, …

24 documentation  bdd  documentation-generation  business-rules 

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 novos …

23 documentation