Manuseio do papel documentação [fechado]

Question

Depois de cada novo programa escrito um monte de documentação em papel continua a ser.

Para além do habitual rabisco notas de programadores geralmente há uma boa pilha de papéis com modelo físico explicações, cálculos e assim por diante (equações, tabelas, gráficos, imagens pouco descrever variáveis ...)

Costumamos fazer numericamente cálculo intensivo em aplicativos de console, que não são liberadas para o público (permanecer na casa, apenas os resultados sair).Antes de cada projeto é terminar todos os artigos devem ser embalados, de alguma forma, com a aplicação, para que um dia, quando alguém vai ser a reutilização de partes do mesmo, tem alguma idéia do que é aquilo lá.Até agora, temos vindo a utilizar o 'sujo' solução de apenas a digitalização de todos-lo e embalá-lo no disco com a aplicação.

Então, eu estava pensando ...para ciência de todos os caras aqui em uma situação semelhante ...como você lida com a documentação do projeto, o que é necessário, mas não liberado para o público ?(o que faz, vai para o dtp laddies, e eles tornam agradável e brilhante - não é problema nosso mais :)

Answer 1

Eu uso uma de três opções:

• Manter tudo em meu laboratório notebooks, que eu arquivamento-me, para baixo-nível coisas
• Digitalizar o documento, e adicionar para controlo de origem no formato pdf.É feio, mas se alguém precisa dele, ele está lá
• Transcrever as equações, resultados, etc...em um ambiente limpo formato (geralmente de Látex), para referência futura, e novamente, adicionar para controlo de origem.Oficial, cópia em papel fica assinado (eu trabalho em um ambiente altamente regulado de domínio), e arquivado em um fichário.

Answer 2

Nos projetos em que trabalhei fizemos um monte de cálculos de física em nossos programas e, consequentemente, temos um monte de quadro sessões com equações em que estamos trabalhando.

Mantemos um wiki para cada grande projeto e depois de cada sessão de quadro de comunicações nós fisicamente fotografia a lousa com uma câmera digital e fazer o upload/organizá-lo dentro da wiki.Nós também digitalizar documentos em papel a partir de desenvolvedores de notebooks se é importante e inclui-la no wiki também.

Então, estamos de volta até a wiki em disco para armazenamento.Portanto, nossa solução é muito semelhante ao seu, diferente de nós usar o projeto wiki para a organização.

Answer 3

Se é importante, parece-me que você deve tratar a documentação interna com o mesmo cuidado com que você trata o público docs.

Answer 4

Eu criar UI papel protótipos ao projetar a INTERFACE do usuário de um aplicativo, o que produz muitas A3 do tamanho de papéis (em um projeto que tinha muitas mesas cobertas com folhas de papel).Quando o projeto está pronto ou se ele precisa ser enviado por correio para alguém, eu tirar fotos com uma câmera digital, para que eu possa produzir uma série de imagens mostrando como realizar algumas tarefas na INTERFACE do usuário, que serve como documentação de como o aplicativo é feito para trabalhar.Isso serve também como uma cópia de segurança, no caso de alguém rouba/limpa distância papéis originais.

Answer 5

Aqui está alguns dos pensamentos...Não é tão prático embora :)

1. Podemos torná-lo parte de nossas observações de Check-in.Isso pode ajudar os desenvolvedores a manter o aplicativo.
2. Atualização a exigência de documento/Baixo nível de documento de design com esses itens