2009-03-13 3 views
3

Это не может быть лучший титул - я был бы признателен, если бы кто-то придумал лучшего после прочтения моей проблемы. Кроме того, я хочу сказать, что я в основном самоучка в Интернете, поэтому может быть много инструментов, о которых я не знаю.Дублируемое обслуживание - код и документация

Я поддерживаю программное обеспечение, реализующее концепцию потокового программирования (FBP) как на Java, так и на C#. Для каждого из них, у меня есть код на:

  • мой сайт
  • SourceForge System Release File (Zip файлов или файлов JAR)
  • SourceForge SVN

Кроме того, у меня есть ссылки на версии и (иногда частично) описания на:

  • мой веб-сайт (HTML)
  • моих вики
  • Javadoc

Существует также инструмент для рисования, а также на моем сайте и SourceForge, который должен знать о последней версии версии Java кода FBP.

Все сшитое довольно тщательно, но иногда я пропускаю ссылку! Несколько дней назад я понял, что долгое время не обновлял SourceForge News для своего проекта, поэтому мне пришлось суетиться и делать это :-)

Я понимаю, что некоторые из этих автомобилей, вероятно, избыточны, но вообще, я не знаю, кто что смотрит.

Итак, мой вопрос заключается в том, есть ли способ уменьшить все эти накладные расходы, например. функция «вложения» в HTML будет приятной, поэтому я могу хотя бы сохранить номер последней версии в одном месте. Возможно, я могу упростить перекрестные ссылки Java, но межъязык будет еще приятнее, но вряд ли, я думаю.

Любые идеи приветствуются.

+0

Это действительно проблематичная проблема, хотелось бы, чтобы была такая панацея для такого рода вопросов. –

+0

Одно предложение: вам больше не нужно использовать SourceForge, потому что GitHub позволяет создавать двоичные версии. Кроме того, вы можете включить ссылки на различные ресурсы, о которых вы говорите, чтобы мы могли понять, насколько глубока ваша проблема. – Seanny123

ответ

3

Мне кажется, что вы хотите обновить и сохранить свою документацию как часть процесса сборки/развертывания, например.

  1. сборки
  2. модульного тестирования и т.д.
  3. документация компиляции
  4. развернуть строит
  5. развернуть скомпилированного документацию

иначе вы всегда будет чеканка свой хвост. Очевидно, что для развертывания документации потребуются разные решения о том, куда они идут (например, скопированы на ваш сайт, FTPed в другом месте и т. Д.)

Я не уверен, что для всего этого существует панацея. Я поддерживаю номера версий в файлах свойств/файлах конфигурации и выполняю соответствующий поиск/замену. Документация по коду, где это возможно, входит в сам код, а затем она предварительно обрабатывается в моей сборке (шаг 3 выше).

Вы видели/использовали Doxygen? Это будет отвечать вашим многоязычным требованиям и хорошо подходит для создания/ведения документации.

0

Похоже, вам необходимо автоматизировать процесс сборки/публикации. Я читал this article на O'Reilly некоторое время назад - кажется, у вас обоих есть похожие ситуации? Его решение сильно использует Python, но, по крайней мере, это может дать вам несколько идей.

Смежные вопросы