OASIS Darwin Information Typing Architecture (DITA) TC

 View Only
  • 1.  DITA 1.3 Spec errata: Missing shortdesc

    Posted 03-15-2016 17:13
    "Zut Alors! I have missed one!"   It looks like we may have missed a short description that is showing up in the HTML version: http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/langRef/containers/troubleshooting-elements.html#reference_xm5_sqz_vm   “Short description needed”   I suggest: “Troubleshooting topics provide sections for describing the condition, causes, and remedies needed to restore a system, a product, or a service to normal. Typically, a cause is immediately followed by its remedy. Multiple cause-remedy pairs can provide a series of successive fall-backs for resolving a condition. For more details on when to use task and other information types, please refer to the DITA architectural specification.”   Thanks and best regards,   --Scott   Scott Hudson Manager, Technical Writing Product Training & Documentation Customer Solutions Jeppesen     Digital Aviation     Boeing 55 Inverness Drive East Englewood, CO 80112 www.jeppesen.com  


  • 2.  RE: [dita] DITA 1.3 Spec errata: Missing shortdesc

    Posted 03-22-2016 22:07
    I have added this to the 1.3 Errata wiki page.   After Kris's suggestion on the TC call today, I also added a note that we should use Schematron to test for any other topics that are missing a <shortdesc>. But note that this will not find the topic seen below, because the text quoted by Scott actually IS in the (properly present) <shortdesc>.   mag   From: dita@lists.oasis-open.org [mailto:dita@lists.oasis-open.org] On Behalf Of Scott C Hudson Sent: Tuesday, March 15, 2016 10:13 AM To: dita Subject: [dita] DITA 1.3 Spec errata: Missing shortdesc   "Zut Alors! I have missed one!"   It looks like we may have missed a short description that is showing up in the HTML version: http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/langRef/containers/troubleshooting-elements.html#reference_xm5_sqz_vm   “Short description needed”   I suggest: “Troubleshooting topics provide sections for describing the condition, causes, and remedies needed to restore a system, a product, or a service to normal. Typically, a cause is immediately followed by its remedy. Multiple cause-remedy pairs can provide a series of successive fall-backs for resolving a condition. For more details on when to use task and other information types, please refer to the DITA architectural specification.”   Thanks and best regards,   --Scott   Scott Hudson Manager, Technical Writing Product Training & Documentation Customer Solutions Jeppesen     Digital Aviation     Boeing 55 Inverness Drive East Englewood, CO 80112 www.jeppesen.com