OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Re: [dita] <cause> short description

Hi Dawn,


I suspect the spec is trying to tell users that if their <cause> is too long, they need *another* troubleshooting topic instead of dropping the detailed and complex âcauseâ into the current topic.


Personally, Iâm OK if you delete it 😊

I donât think the red text youâre asking about belongs in a specâ






Gershon Joseph | Senior Information Architect | Precision Content 
Direct: +972 (54) 658-3887| Email: gershon@precisioncontent.com | www.precisioncontent.com




Unlock the Knowledge in Your Enterpriseâ

This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you are not the intended recipient you are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this information is strictly prohibited. Please notify us by return email if you have received this email in error. Â2020, Precision Content Authoring Solutions Inc, Mississauga, Ontario, Canada



From: <dita@lists.oasis-open.org> on behalf of Dawn Stevens <dawn.stevens@Comtech-serv.com>
Date: Tuesday, 25 August 2020 at 1:42
To: "dita@lists.oasis-open.org" <dita@lists.oasis-open.org>
Subject: [dita] <cause> short description


While writing the topics for the <diagnostics> proposal stage 3, I was looking at the topics for the rest of the troubleshooting topic elements to ensure I modelled the writing there.


<cause> is described as follows:


The <cause> element describes a potential source of the problem that is described in the <condition> element, the topic <title> element, or the <shortdesc> element. This information should be brief; if it is not possible to make the information brief, this might be a sign that a full troubleshooting topic is needed.



I donât understand the last sentence, after the semi-colon. <cause> is part of a full troubleshooting topic. What is it trying to tell me to do if my cause is long?

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]