manutenção duplicado - código e documentação [fechado]

Question

Isto pode não ser o melhor título - eu apreciaria se alguém viria acima com um melhor depois de ler o meu problema. Além disso, eu quero dizer para frente que eu sou autodidata na Internet, portanto, pode haver muitas ferramentas que eu não estou ciente de.

Estou mantendo software implementando o conceito de programação Flow-Based (FBP) em Java e C #. Para cada um deles, eu tenho código em:

• meu site
• Arquivo SourceForge de Lançamento (arquivos zip ou arquivos jar)
• SourceForge SVN

Além disso, tenho referências de versão e descrições (às vezes parciais) em:

• meu site (HTML)
• meu wiki
• Javadoc

Há também uma ferramenta de desenho, também no meu site e SourceForge, que tem de saber sobre a versão mais recente da versão Java do código FBP.

Tudo é reticulado muito bem, mas às vezes eu sinto falta de uma referência! Alguns dias atrás, eu percebi que eu não tinha atualizado SourceForge Notícias para o meu projeto em um longo tempo, então eu tive que confusão e fazer isso :-)

Eu percebo que alguns destes veículos são provavelmente redundante, mas geralmente, eu não sei quem está assistindo o.

Então, minha pergunta é se existe uma maneira de reduzir toda essa sobrecarga, por exemplo, um HTML "encaixar" função seria bom, para que eu possa, pelo menos, armazenar o número da versão mais recente em um só lugar. Eu provavelmente pode simplificar as referências cruzadas Java, mas inter-linguagem seria ainda mais agradável, mas pouco provável, eu acho.

Todas as idéias seriam bem-vindos.

Answer 1

Parece-me que você deseja atualizar e manter a documentação como parte de sua construção processo / deploy por exemplo.

1. construção
2. teste de unidade etc
3. documentação compilação
4. deploy constrói
5. deploy documentação compilado

caso contrário, você sempre vai ser perseguindo o próprio rabo. Obviamente, a implantação documentação exigirá soluções diferentes sobre onde está indo (por exemplo copiado para o seu site, FTPed outro lugar etc.)

Eu não estou certo que há uma panaceia para tudo isso. I manter números de versão em arquivos de propriedades / arquivos de configuração, e fazer apropriadas de pesquisa / substitui. Código documentação sempre que possível vai no próprio código, e então isso é pré-processado na minha construção (etapa 3 acima).

Você viu / utilizado doxygen ? Que irá lidar com suas necessidades multi-língua, e é bem estabelecida para a construção / documentação manutenção.

Answer 2

Parece que você precisa para automatizar o processo de compilação / publicar. Eu li este artigo em O'Reilly algum tempo atrás - é parece que ambos têm situações bastante semelhantes? Sua solução faz uso pesado de Python, mas, pelo menos, pode dar-lhe algumas ideias.