Я покинул свою предыдущую компанию несколько недель назад и должен признать, что они очень довольны моей консультацией.Моя проектная документация основана на диаграммах классов UML, в основном на нескольких других диаграммах.
Я использовал инструмент из компании с именем O .... o EclipseUML, чтобы преобразовать мой полный Java-проект в UML.Он перевернул не только код, но и все мои аннотации Java-персистентности.После того, как я изменил свой проект, чтобы получить свою модель UML, я создал представления из своего проекта, перетаскивая abd drop классов и интерфейсов в пустые диаграммы классов.Наконец, я позволил многим комментариям непосредственно в диаграммах записку (например, желтую), а также оставил java doc видимым на некоторых диаграммах в виде заметки.
наконец, я оставил код с полной моделью, прикрепленной к нему, и около 50диаграммы классов.Я не сгенерировал бумажную документацию, но если вы откроете свой проект с помощью Eclipse Helios, то у вас будет в корне каждого пакета соответствующие диаграммы классов, включая мои заметки.Если вы щелкнете по классу на одной из диаграмм, вы увидите мои комментарии, написанные непосредственно в модели.и т. д. Я бы сказал, что моя документация теперь синхронизирована с кодом в реальном времени, и для нового разработчика будет очень легко понять весь проект всего за несколько часов, перемещаясь по коду и просматривая объяснения UML двойным щелчком мыши.
Я думаю, что бумажная документация бесполезна, потому что вы никогда не понимаете всю суть проекта.Я считаю, что мой проект, использующий UML, смешанный с проектом и синхронизированный с кодом, намного мощнее.
Надеюсь, что эта помощь