Report mapping document responsibility

[former_member672670]

HIe Guys,

just had a basic question about report mapping document - one that lists all the reports in a project and maps the report elements with universe object. Is it the responsibility of the developer to create such a document when he leaves a project  or when he starts a project ? Whose responsibility is it ?How does it work ? Thanks.

[arijit_das · Accepted solution]

This is entirely depends on how you are managing your project. This is a good practice to have a design document signed off from client before you start development. If you document your development somehow, this will definitely help you or anyone else in future changes.

Now, this may not be the developer always who should create the documentations, but whoever does this should have a fair knowledge of the developments done to avoid wrong or incomplete docs.

[former_member672670 · Accepted solution]

SO it is the job of the primary  developer who designed the report to create such document so that it can facilitate a new developer who joins the team ?

[arijit_das · Accepted solution]

Well, let me re-iterate, this is something which depends on how the project is being managed by the project manager. Documentation is an important part of a project and should be done in a well-constructed and understandable way. If the primary developer is the best fit for the task, then the manager may select him for this task.

[abhinav_shrivastava1 · Accepted solution]

In my view, its should be the task of Primary developer to Initiate the documentation, and in case he been moved to another Project a warm Handover should be done followed by a quick Knowledge transfer.

And the same should be followed by others.

So will be a Win-Win situation for anyone who is joining new the project.

-Abhi

[former_member672670 · Accepted solution]

Is there a specific sample/format that every company follows or is it dependent on whoever designs the document?

[arijit_das · Accepted solution]

Every company normally has it's own documentation format / template. The doc should describe the requirement, design architecture, objects in each layer, assumptions etc. A good documentation (can consists of multiple docs) should be able to answer questions such as:

1. What is the purpose of the development.

2. Who are the target users.

3. What are the layers of the solution provided.

4. What are the objects in each layer.

5. Any assumption.

6. Limitation if any.

A separate user manual is also delivered in many projects.

[former_member672670 · Accepted solution]

Do I just need to include details about  the output  report columns or every object in the report?

[arijit_das · Accepted solution]

You can specify the formula used in each column and variable definition.

[Former Member · Accepted solution]

If you are doing the documentation of the report you should include all the details available for columns in your document