Module Diff

What it is and why it exists

"What has changed in this module since the last baseline?" is one of the most frequent questions before a review, a release or an audit. DOORS Next can compare configurations, but on a large module the comparison takes a long time and the result is hard to go through.

Module Diff answers the question inside the ELM Mini Dashboard next to the module. Choose a baseline of the current stream, or another stream or baseline of the same component, and the widget lists every requirement that was added, removed, changed or moved, with the text before and after. The widget only reads. Nothing in DOORS Next changes.

Problems it solves

• Comparing a large module with a baseline takes too long, so it is skipped or done only at the end.
• Reviewers have to find the few changed requirements among thousands of unchanged ones.
• Moved requirements and changes of the outline are easy to overlook.
• Change reviews and audits need a record of what changed, which is hard to put together by hand.

Benefits

• Fast: the other configuration is read in batches and only short fingerprints of the texts are kept, so even large modules are compared quickly.
• One list: added, removed and changed requirements in module order, with their headings for orientation, or every requirement with All artifacts.
• Before and after: open a requirement to see the old and the new text line by line, the name, the artifact type, the place in the module and what you chose to compare: links by link type, tags, comments and attributes.
• Easy to go through: headings stand out in the list and fold with their +/− box, and the search and the lists over the list narrow it by text, artifact type or headings.
• Either direction: Swap turns the comparison round at once, without reading anything again.
• Structure too: requirements that moved to another chapter, changed order or changed level are marked as such.
• Ready for a review or an audit: the comparison goes to Excel in the same layout as every SmarterWidgets log, with counts and both configurations named.
• Safe for everyone: the widget only reads, so anyone may use it at any time.

How to use

1. Open the module. Under Compare, From shows the configuration you work in. Under To, choose the baseline or stream to compare with: the baselines of this stream first, then the other streams and baselines of the component. Swap turns the comparison round.
2. Under Attributes to compare, click Change and tick what should be compared: Primary Text (Contents), Tags, Comments, attributes such as status or priority, and link types, or Select all. Name, artifact type and place in the module are always compared.
3. Click Compare module. A progress bar shows how far it is; you can stop at any time.
4. The result counts added (only in To), removed (only in From), changed and unchanged requirements. Differences lists the changes under their headings; the search field and the lists over it narrow the list by text, artifact type or headings, and All artifacts lists every requirement.
5. Open a requirement to see the text before and after, line by line, and its attributes side by side. Show in module takes you to it.
6. Log next to the result (or the download icon at Differences) saves the comparison to Excel for a review or an audit.

Good to know

• Texts are compared as plain text: a change of formatting only (bold, colour) does not count as a change.
• Links, tags and comments are read in both configurations the same way, so only real differences are listed.
• In a global configuration the module is compared within its own component, with that component's streams and baselines.
• Very large modules can be compared in parts: stop the run, reload the page, open the module again and click Continue to go on where it stopped.
• Requirements that could not be read in the other configuration are listed as not compared, with the reason.