Perguntas com a marcação «documentation»

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, que está realizando um …

12 web-development  documentation  html  css 

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, preciso trabalhar com vários tipos de arquivos …

12 documentation  reverse-engineering 

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 formulário, texto informativo …

12 documentation  business-rules 

Atualmente, estou trabalhando na minha graduação para meus estudos de "Desenvolvimento de Software", nos quais tenho que desenvolver software complexo individualmente em uma empresa externa. Tudo isso precisa ser feito de maneira estruturada, criando todos os documentos correspondentes. Para este projeto, decidi trabalhar com os documentos padrão do IEEE: Documento …

11 design  documentation  software  iso 

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á 6 anos . Eu sou um defensor de comentar sobre o código fonte e documentar os …

11 productivity  documentation  code-quality  maintainability  engineering 

Existem práticas comuns para comentar as expressões regulares: comentários embutidos que referem parte diferente do RegEx ou comentário geral para todas as expressões?

11 documentation  coding-style  comments 

Estamos procurando reformular a documentação em toda a nossa linha de produtos. Parte disso inclui manuais de referência para uma linguagem de programação usada como parte do sistema. Ao escrever um manual de referência para uma linguagem de programação, qual é a melhor maneira de estruturá-lo para maximizar a usabilidade …

11 programming-languages  documentation 

Eu tenho um projeto para a universidade que não iniciarei imediatamente, mas tenho pensado por um período razoavelmente longo. Eu entendo que o desenvolvimento de projetos da Universidade não é como a indústria (atualmente sou estagiário), então a situação que vou apontar no momento provavelmente parecerá um tanto ridícula para …

11 documentation  iterative-development 

Ocasionalmente, há 1% de código que é intensivamente computacionalmente e precisa do tipo mais pesado de otimização de baixo nível. Exemplos são processamento de vídeo, processamento de imagem e todos os tipos de processamento de sinal, em geral. Os objetivos são documentar e ensinar as técnicas de otimização, para que …

11 documentation  code-reviews  optimization 

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 completei um aplicativo Web que é basicamente desenvolvido em …

11 project-management  documentation  documentation-generation  projects-and-solutions 

Eu quero melhorar minhas habilidades de programação estudando projetos de código aberto famosos, mas acho que é fácil se perder apenas pulando no código-fonte. Então, decidi ler a documentação deles sobre o design ou a arquitetura (como diagramas UML) para ter uma idéia geral da organização do código primeiro. Para …

11 open-source  documentation  asp.net-mvc 

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á 5 anos . Estive lendo algumas propostas de projetos de software recentemente e …

11 documentation 

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á 2 anos . Alguém já tentou criar uma documentação completa do código …

11 documentation 

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 perguntei como você encontra API privada / …

11 programming-languages  learning  documentation  api 

Após muita pesquisa, não consegui responder a uma pergunta básica referente a um suposto conhecido no mundo do desenvolvimento de software: O QUE É CONHECIDO: A imposição de uma política rigorosa na documentação adequada do código (sejam tags Doxygen, Javadoc ou simplesmente uma abundância de comentários) aumenta o tempo necessário …

11 java  c#  c++  documentation  coding-standards