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


Help: OASIS Mailing Lists Help | MarkMail Help

dita-techcomm message

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

Subject: Do we have a clear list of requirements for the troubleshooting topic?

There's lots of information on the Wiki page at https://wiki.oasis-open.org/dita/Troubleshooting, but it covers the other DITA 1.3 proposals also.

Here are my thoughts about a really minimal solution/bottom-line requirements:
  • Pre-built topic type
    • Rationale: Easy for content developers to use, especially non-information developers; editing tools can use CSS to provide a good user experience
  • Metadata to specify who the people involved are
  • Major sections to cover the following sorts of content (labels customizable and automatically generated by processor)
    • Problem
    • Explanation
    • Resolution
  • Ability to use <steps> at least once
    • Rationale: Be able to conref content from existing topics, or promote content from the troubleshooting topic into a task topic without a writer needing to move content out from an <ol>.
  • Produce "Related troubleshooting" label for links generated from relationship tables or <link> elements

What do other people see as the most basic requirements?

Kristen James Eberlein
Principal consultant, Eberlein Consulting
Co-chair, OASIS DITA Technical Committee
Charter member, OASIS DITA Adoption Committee
+1 919 682-2290; kriseberlein (skype)

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