Wanted to ask the user-base a quick question...I'm new to DOORS.
When inputting (importing or copy/pasting) into DOORS from a pdf or Word doc., what is the general rule of what should be included in each object?
In other words, do most users enter a paragraph number and heading in the object only (and the text of the requirement in the next object), or paragraph number, heading, and body text all in one object.
The practice would definately affect how traceability reports would look.
e.g.,
Obj1 3.1.2.3 This is the heading
Obj2 This is the body of the requirement
-------vs--------
Obj1 3.1.2.3 This is the heading
This is the body of the requirement
ANyway, would like to hear what others are doing and if there is a general rule...thanks!
GK
gkane - Fri Oct 29 15:16:33 EDT 2010 |
|
Re: Inserting New Objects and Headings...General DOORS entry question... SystemAdmin - Fri Oct 29 16:10:47 EDT 2010
Generally accepted best practice is to put the Heading in one object and any text objects underneath that. You don't need to put any heading numbers in, DOORS will automatically assign numbers based on the structure of the module.
If you are importing from Word then this all happens for you as long as the Word document is using heading styles with levels and not just bold text.
When entering data direct from the keyboard into DOORS you will notice that every time you create a new object it shows a heading number. If you want to add text only then use one of the many ways to 'Edit Object Text' (CTRL+T is a good one) and the number will disappear.
Don't forget to keep an eye on the structure of the module with the module explorer.
|
|
Re: Inserting New Objects and Headings...General DOORS entry question... gkane - Fri Oct 29 16:16:29 EDT 2010 SystemAdmin - Fri Oct 29 16:10:47 EDT 2010
Generally accepted best practice is to put the Heading in one object and any text objects underneath that. You don't need to put any heading numbers in, DOORS will automatically assign numbers based on the structure of the module.
If you are importing from Word then this all happens for you as long as the Word document is using heading styles with levels and not just bold text.
When entering data direct from the keyboard into DOORS you will notice that every time you create a new object it shows a heading number. If you want to add text only then use one of the many ways to 'Edit Object Text' (CTRL+T is a good one) and the number will disappear.
Don't forget to keep an eye on the structure of the module with the module explorer.
Excellant, that's what we've been doing.
We're doing straight imports from Word and its coming in as bold text, not really getting into heading styles and levels, which meets our needs.
Thanks!
|
|
Re: Inserting New Objects and Headings...General DOORS entry question... llandale - Mon Nov 01 09:50:20 EDT 2010 SystemAdmin - Fri Oct 29 16:10:47 EDT 2010
Generally accepted best practice is to put the Heading in one object and any text objects underneath that. You don't need to put any heading numbers in, DOORS will automatically assign numbers based on the structure of the module.
If you are importing from Word then this all happens for you as long as the Word document is using heading styles with levels and not just bold text.
When entering data direct from the keyboard into DOORS you will notice that every time you create a new object it shows a heading number. If you want to add text only then use one of the many ways to 'Edit Object Text' (CTRL+T is a good one) and the number will disappear.
Don't forget to keep an eye on the structure of the module with the module explorer.
I enhance this good post.
Yes, almost always separate the Headings from the Text in different objects; certainly 'important' information like "Requirements" or "Test Procecures" should be in their own objects. However 'un-important' information such as "This section describes..." Text could (and I believe "should") be in the same object as the Heading.
Strangely, an empty object is counted as a Heading. Yes, the Paragraph Number disappears from the main column when you add text, but it does not just "disappear", it also changes the number and therefore the number of subsequenty siblings. If you add two empty objects and then edit the text of the 1st, you will notice the displayed paragraph number of the 2nd one will change. "Text" objects (those that don't display Paragraph in the Main Column) have Paragraph Numbers that end in ".0-n" (n is a number); whereas 'Heading' objects lack the "0-" part. So paragraph number "3.2.1.0-3" means this is the 3rd text object under 3.2.1.
When dealing with module structure it should be routine to display the 'Object Level' and the 'Object Number' columns. This includes whenever you figure to move, copy, paste, insert, remove, add text or other such chores.
|
|
Re: Inserting New Objects and Headings...General DOORS entry question... llandale - Mon Nov 01 09:53:01 EDT 2010 llandale - Mon Nov 01 09:50:20 EDT 2010
I enhance this good post.
Yes, almost always separate the Headings from the Text in different objects; certainly 'important' information like "Requirements" or "Test Procecures" should be in their own objects. However 'un-important' information such as "This section describes..." Text could (and I believe "should") be in the same object as the Heading.
Strangely, an empty object is counted as a Heading. Yes, the Paragraph Number disappears from the main column when you add text, but it does not just "disappear", it also changes the number and therefore the number of subsequenty siblings. If you add two empty objects and then edit the text of the 1st, you will notice the displayed paragraph number of the 2nd one will change. "Text" objects (those that don't display Paragraph in the Main Column) have Paragraph Numbers that end in ".0-n" (n is a number); whereas 'Heading' objects lack the "0-" part. So paragraph number "3.2.1.0-3" means this is the 3rd text object under 3.2.1.
When dealing with module structure it should be routine to display the 'Object Level' and the 'Object Number' columns. This includes whenever you figure to move, copy, paste, insert, remove, add text or other such chores.
... and ... when adding text and heading, its best if new folks display the "Object Heading" and "Object Text" attributes (in addition to Main) and edit them mindfully in their own columns; then look at the Main column to see the changes. More experienced folks can edit directly in the Main since they understand what's going on.
|
|
Re: Inserting New Objects and Headings...General DOORS entry question... kierant - Mon Nov 01 10:40:18 EDT 2010
Hi - Just to add to above contributions, which I agree with. One mistaken approach I've seen people adopt here is to treat the heading like a title for a reqmt. This is incorrect, as heading should be to trigger a whole new section in the doc, with each reqmt a separate object below it. If those reqmts need some kind of titles then 'Object Short Text' is probably the way to achieve this, but not headings.
Kieran
|
|
Re: Inserting New Objects and Headings...General DOORS entry question... llandale - Mon Nov 01 13:30:14 EDT 2010 kierant - Mon Nov 01 10:40:18 EDT 2010
Hi - Just to add to above contributions, which I agree with. One mistaken approach I've seen people adopt here is to treat the heading like a title for a reqmt. This is incorrect, as heading should be to trigger a whole new section in the doc, with each reqmt a separate object below it. If those reqmts need some kind of titles then 'Object Short Text' is probably the way to achieve this, but not headings.
Kieran
Indeed Object Short Text. I did, however, write a function to display the 'Title' for an object, which was its Short Text, or if null then its Object Heading, and if null then Title of its parent, recursively. Thus, if Short Text was not filled in then eventually some Object Heading would be displayed.
I thought it worked great but the powers that be decided they didn't want to see Titles in this report.
|
|
Re: Inserting New Objects and Headings...General DOORS entry question... aalmo - Mon Nov 01 22:56:36 EDT 2010 llandale - Mon Nov 01 09:50:20 EDT 2010
I enhance this good post.
Yes, almost always separate the Headings from the Text in different objects; certainly 'important' information like "Requirements" or "Test Procecures" should be in their own objects. However 'un-important' information such as "This section describes..." Text could (and I believe "should") be in the same object as the Heading.
Strangely, an empty object is counted as a Heading. Yes, the Paragraph Number disappears from the main column when you add text, but it does not just "disappear", it also changes the number and therefore the number of subsequenty siblings. If you add two empty objects and then edit the text of the 1st, you will notice the displayed paragraph number of the 2nd one will change. "Text" objects (those that don't display Paragraph in the Main Column) have Paragraph Numbers that end in ".0-n" (n is a number); whereas 'Heading' objects lack the "0-" part. So paragraph number "3.2.1.0-3" means this is the 3rd text object under 3.2.1.
When dealing with module structure it should be routine to display the 'Object Level' and the 'Object Number' columns. This includes whenever you figure to move, copy, paste, insert, remove, add text or other such chores.
Louie:
I agree with you that boilerplate can have Object Heading and Object Text in the same object (and may be desirable). Back in DOORS 6 or 7 days Telelogic recommended that an object have either Object Heading or Object Text but not both. There was no restriction to enforce this recommendation and the Paragraph Style attribute could contain "<Object Heading:Heading 2><Object Text:Body Text>" and the export to Word would be correct with the proper style applied to each.
However, my brief exposure to RPE implies there is only ONE style applied to each object. If this is truly the case, objects with both Object Heading and Object Text cannot be formatted properly.
|
|