ProductsUModelUML Project Documentation

Creating and maintaining documentation for any software project can be a tedious and time consuming task. UModel® 2008 steps up the pace of productivity by generating documentation files for you automatically.

Documentation is an important part of your software development project – to measure progress toward completion, to communicate functionality among team members, and to provide a project roadmap later on when the application needs to be updated. UModel® 2008 accelerates this step by automatically generating documentation for you in HTML, Microsoft Word, or rich text (RTF) formats.

A selection in the Project Menu lets you generate project documentation at any time:

Once you select the output format, UModel® 2008 provides extensive options to customize the project documentation for your needs. In an early development iteration you might want to focus on a single diagram type – state machine diagrams or sequence diagrams, for instance, as you work through all the issues of application flow. Later on during code engineering, you may want to focus exclusively on class diagrams.

When your project is complete, the Select all Diagrams and Select All Elements buttons help you quickly generate a complete record of your project.

You can also select the level of details to include for each element. For instance, checking the box for Hierarchy diagrams greatly assists understanding of class definitions.

Whichever output format you choose, UModel® 2008 adds links to aid navigation. In HTML format, hyperlinks embedded in the documentation act as expected in any Web browser. Even links to the generated source code files are included in your project documentation.

Similarly, UModel project documentation created in word processor formats also includes links that help users quickly follow the thread of a subject of interest.

Selecting the Index option adds a document summary with links you can navigate to the major sections.

Of course, you can also control the appearance of project documentation by individually specifying the type style and size of each text block.

Accelerate completion of your own software development projects by generating project documentation with UModel® 2008. Download a free 30-day trial today!