Developer/Designer Notes

Archive for the ‘documentation’ Category

Template for Reviewing Fields in the Screen/Config Files

Posted by Kiran Mova on September 7, 2007

Dan Brown in his book on Communicating Design explain the need for the documents and process of creating effective documents. His deliverables are at a high level and are applicable to the entire project life cycle.

Here is an document that is useful during the implementation phase.

When designing new screens which haven’t been delivered to the customer, it is hard to determine what works and what doesn’t. A lot of assumption from previous experience or intuition are made during the implementation. Even though, we might have an requirements specification, the one which is very detailed and verbose and which tries to cover in detail what goes into what release, it is hard to reference it.

I have found it helpful to have a tabular document recording the details of each field and having it reviewed by the key people in the project like the system designer, developer and the system tester.

Field Name Description Validations Source Issues/Questions Comments
Name or identifier Notes on why the field is required and how it can be represented, readwrite/read-only etc,. Tool tip, Code validations, assumptions etc., user configurable or default (hard coded) questions to bring up in the review capture the comments from review
Advertisements

Posted in documentation | Leave a Comment »