Perguntas com a marcação «documentation»

Atualmente, estou no processo de atualizar um documento de design para que esteja correto e atualizado para futuros desenvolvedores. Atualmente, o documento concentra-se apenas nos fatos, apresentando como é o design. Não há justificativa para nenhuma decisão apresentada. Acredito que é importante...

Gostaria de saber quais opções estão disponíveis para documentar um projeto que já foi desenvolvido, pois os desenvolvedores que trabalharam não escreveram sequer uma única página de documentação. O projeto não possui outros detalhes além de muitas páginas de scripts com funções escritas e...

Eu tenho um banco de dados MongoDB que desejo documentar adequadamente seu design de esquema. Sei que o MongoDB é um banco de dados NoSQL e não possui esquema por natureza, mas imponho um esquema por meio do meu aplicativo e quero representá-lo de uma maneira melhor do que a impressão de um...

Atualmente, estou usando dois sistemas para escrever documentação de código (estou usando C ++): A documentação sobre métodos e membros da classe é adicionada ao lado do código, usando o formato Doxygen. Em um servidor, o Doxygen é executado nas fontes para que a saída possa ser vista em um...

O W3Schools tem a reputação de estar incompleto, às vezes incorreto e com publicidade; Ainda assim, ao procurar algumas coisas ou vincular-se à documentação ao responder uma pergunta de SO, ainda é o único recurso útil entre navegadores. Existem outros recursos, como a Mozilla Developer Network,...

Existe um bom termo semelhante, mas diferente de "descontinuar", para significar que um método ou API está na base de código, mas não deve ser usado porque sua implementação não está completa ou provavelmente será alterada? (Sim, eu sei, esses métodos não devem ser públicos, yada yada yada. Eu não...

Quando dizemos 'documentação' para um produto de software, o que isso inclui e o que não deve incluir? Por exemplo, uma pergunta recente perguntou se os comentários são considerados documentação? Mas há muitas outras áreas para as quais essa pergunta também é válida, algumas mais óbvias que...

Importante : não temos nenhum problema com a documentação do código fonte . Isso pertence à auditoria regular de código e é mantido atualizado. Nosso problema é com a documentação dos desenvolvedores (ou "externos", se você preferir), pequenas dicas de programadores para programadores que tendem a...

Atualmente, usamos um sistema chamado AsciiDoc que permite criar documentação em uma simples marcação de texto. A partir disso, podemos gerar vários formatos de saída. Utilizamos apenas os formatos de saída pdf e chm. Eu queria saber se havia uma alternativa para chm? O que estou procurando é algo...

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á 6 anos . Eu sou o criador de...

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 . Toda vez que...

Sou desenvolvedor de software e trabalha em uma empresa de sistemas embarcados. Temos um gerente de projeto, que cuida do cronograma geral do projeto (incluindo elétrica, qualidade, software e fabricação), portanto, o cronograma do software é muito breve. Também temos um gerente de software, quem...

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 . Nossa empresa está...

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á 6 anos . Para um projeto,...

Fechado . Esta pergunta precisa de detalhes ou clareza . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Adicione detalhes e esclareça o problema editando esta postagem . Fechado há 4 anos . RFC : Request for Comments (RFC) é...

Entendo a diferença entre os dois, mas sou questionado por meus colegas sobre o benefício dos requisitos de rotulagem como funcionais ou não funcionais (ou transitórios). Por que se preocupar em fazer isso? Ele passou o que ele disse serem dois dias revisando uma lista de requisitos para um projeto...

Gostaria de saber qual seria o método formal e o mais comumente praticado para documentar as regras de negócios? Além disso, como você documenta as especificações da interface do usuário de artefatos de desenvolvimento (por exemplo, Documentando campos de formulário e como os botões se comportam no...

Tenho que documentar meu programa para um projeto da escola e temos a seção chamada "domínio do problema", mas não tenho idéia do que discutir nesta seção. Portanto, a pergunta é: o que deve ser discutido no domínio do

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 . Eu sempre me...

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 . o objetivo é...