Updated .zip archive
Here is a .zip archive containing the latest Troubleshooting files. The .zip archive contains:
- JoAnn's revised file for the Troubleshooting elements topic
- JoAnn's modifications to General Task, Strict Task, and Machinery Task topics from the architectural specification
- Revised files that incorporate all comments made on these Phase 3 proposals: 13086 step troubleshooting, 13096 task troubleshooting, and 13098 note attribute trouble value.
- Updated files on proposal 13097, troubleshooting topic.
Please see README.txt for more information.
Troubleshooting topic
Proposal 13097 still requires Phase 2 approval. We may be ready to seek that soon. But, there are some issues we must agree upon about the content model, and the material that we are to submit should be reviewed internally.
Changes to the troubleshooting topic content model:
- The strawman proposal allowed a mix of basic blocks (parameter entity %body.cnt;) to preceed condition, cause, and remedy. This was simply a hangover from the topic model, which is the inherited type for troubleshooting. Removing the mix simplifies the structure and will not stymie a writer's need to say some things before the condtion, cause, and remedy elements. They can use shortdesc or abstract in the rare cases where this is necessary.
- The condition element may only appear once at the beginning of troublebody. Previously, it was available inside a mix along with cause and remedy. This request came from Dan Dionne at IBM. It seems reasonable to allow no more than one condition per troubleshooting topic. If anybody can come up with an example where that restriction does not make sense, then we should consider rolling the model back to where multiple condition elements are allowed. One advantage of this restriction is that writers can no longer unwittingly place the condition after its corresponding causes or remedies.
Best Regards,
--
Bob Thomas
![]()
Bob Thomas
+1 720 201 8260
Skype: bob.thomas.colorado
Instant messaging: Gmail chat (bob.thomas@tagsmiths.com) or Skype
Time zone: Mountain (GMT-7)