Faq

From a Maintenance perspective
What to look for in requirements

As a Maintenance representative you can be asked to review Requirements. Probably you can review these on involvement of maintenance aspects.

Relation to the document

RR_1stReceipientAfter your review

You must feel confident to announce that “The requirements completely cover maintenance aspects with the correct priority and the nonfunctional requirements are realistic.”

Review suggestions

  • The requirements fit into the current environment/situation.
  • Requirements to perform (and prevent) maintenance are described.
  • Requirements are realistic to be fitted in the current system/environment.
  • Previous production incidents are prevented or described as risks including preventive and repressive measures.

Permalink.

What to look for in functional designs

As a Maintenance representative you can be asked to review Functional designs. Probably you can review these on understandability and maintainability.

Relation to the document

RR_2ndReceipientAfter your review

You must feel confident to announce that “This functional design is unambiguously clear, does not contain assumptions and takes into account that what is described can be maintained when it’s in production.”

Review suggestions

  • The design is completely clear, providing insight in impact, risks and tasks when this functionality gets implemented in production.
  • The main risks are prevented or covered by error handling.
  • Alternative handling is described (e.g. manual instead of automated) for the most risky parts.
  • Production issues which occurred in the past are prevented.

Permalink.

What to look for in technical designs

As a Maintenance representative you can be asked to review Technical designs. Probably you can review these on understandability and maintainability.

Relation to the document

RR_2ndReceipientAfter your review

You must feel confident to announce that “This technical design is unambiguously clear, does not contain assumptions and takes into account that what is described can be maintained when it’s in production.”

Review suggestions

  • Values should be designed to be parametrized/configurable instead of hard coded.
  • Error codes and messages must be unique and detailed enough.
  • Production issues which occurred in the past are prevented.

Permalink.

What to look for in test cases

As a Maintenance representative you can be asked to review Test cases. Probably you can review these on coverage of maintenance options and handling error situations.

Relation to the document

RR_1stReceipientAfter your review

You must feel confident to announce that “These test cases cover all maintenance needs in order for me to prevent or handle (functional) production problems when they occur. Risks based on previous experiences are covered by these test cases.”

Review suggestions

  • Previous production incidents related to the same scope or functionality are covered by the tests in order to check that it will not occur again or can be handled.
  • The test cases can be repeated by the maintenance team to test production fixes.
  • The coverage of (production) risks is clear and complete enough.

Permalink.

How to approve or disapprove

All reviewers, regardless of their participation, receive an approval request when the rework is finished.

For general information check the Approval Phase.

Approved or disapproved

Approve the rework if you are confident that the comments are correctly reworked. You should be able to say from your own perspective that “I agree with the rework which is performed and I agree with the author’s reaction on the rejected comments.”

When you do not agree with the performed rework or with the reaction of the author, notify the moderator. When doing so, state clearly why you disapprove and what you expect to be done to get it approved.

Result of a disapproval can be a second rework round or a decision not to fix it. In all situations both the reviewer and author should feel OK with the decision.

I did not have comments, should I still (dis)approve the rework?

Yes, definitely. The document (which you already considered being “perfect”, since you did not have review comments) is reworked, so it might not be perfect anymore! So, even though you did not have comments, you still must approve or disapprove the rework.

Permalink.