RE: (ROSE) Check that a class has documentation

[James J. Wagner]

Title: Check that a class has documentation

I understand Tony's point of view. However, it depends on whether you think of this as a monitoring task that is enforcing something, or as a help. I have a certain type of class where I always need to enter a value for a particular attribute. I (and others) almost always forget, and I had a message that used to say, "You didn't enter a value for xxx". I got tired of that and changed it so that it would prompt the user for the information. Now, if I forget, it prompts me and I can fix it. So... I think it is a great help, rather than some type of process police.

 

Also... Rose is a tool that can be greatly extended. So, my team can extend it to do what makes sense for us. I totally agree that Rose, out of the box, shouldn't force documentation. But, for my team, documentation is required. It is a tool, and we can extended it to meet our needs and help us out. Yes, we have peer reviews... but having a review where everyone says "Hey you forgot to document that" is kind of a waste of time. Having Rose tell you ahead of time, you fix it, and then you generate the doc and have the review is better.

 

As for Engman's request... personally I'm not sure if I'd require documentation be filled in at the time the thing was created, but I can see where that makes sense. I'm not sure how I'd do that. But, it would be easy to write a script that checks for empty documentation, and if it finds any either writes it to the Rose log, prompts the user for input, etc.

 

    James.

-----Original Message-----
From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]]On Behalf Of Picarello, Anthony
Sent: Friday, March 09, 2001 8:59 AM
To: Engman Petra - peen; [EMAIL PROTECTED]
Subject: RE: (ROSE) Check that a class has documentation

With all due respect, why force this monitoring task on Rose?  You'll catch the empty documentation fields during the review.  Then you'll force the user to go back and do it the way you want, or they'll box up their goods and look for a new job that allows them to do it "their" way.

 

I am on my soapbox now... too many times I hear requests (not just from this forum) for Rose functionality does not belong in the tool;  like the functionality mentioned in this post (nothing personal Engman).  Code generation format is another.

 

Rose is just a tool to help the developer, and it can't do it all for us.  We, as developers, still have to have processes in place that allows us to use Rose in a manner suitable to the Project (peer reviews, defect tracking, etc.).

 

----------------------------------------------------
Tony Picarello
Engineer
Science Applications International Corp.

Voice: 407-207-2791
Fax:    407-282-4530
Email: mailto:[EMAIL PROTECTED]

 

 

-----Original Message-----
From: Engman Petra - peen [mailto:[EMAIL PROTECTED]]
Sent: Friday, March 09, 2001 10:19 AM
To: [EMAIL PROTECTED]
Subject: (ROSE) Check that a class has documentation

Hi,
I would like to force our Rose users to enter documentation on each class and its attributes. At least give a warning if the documentation field is empty.

The ideal place to do this is when the specification window is closed.
Does anyone know how to do this?

-----------------------------------------------------------------------------------------------
Petra Engman                                                      email:       mailto:[EMAIL PROTECTED]
Industri Matematik International Corp                    phone:     +46 8 676 51 72
Stadsg�rden 10                                                      fax:          +46 8 676 50 10
Box 15044, SE-104 65 Stockholm, Sweden           http://www.im.se

************************************************************************
* Rose Forum is a public venue for ideas and discussions.
* For technical support, visit http://www.rational.com/support
*
* Admin.Subscription Requests: [EMAIL PROTECTED]
* Archive of messages: http://www.rational.com/products/rose/usergroups/rose_forum.jtmpl
* Other Requests: [EMAIL PROTECTED]
*
* To unsubscribe from the list, please send email
*
* To: [EMAIL PROTECTED]
* Subject:<BLANK>
* Body: unsubscribe rose_forum
*
*************************************************************************