Lightweight DITA SC

Expand all | Collapse all

Thoughts on a survey

  • 1.  Thoughts on a survey

    Posted 06-20-2016 20:12
    How about this for dita-users: 1 - link to overview/description of lightweight DITA for them to review first 2 - Which of the following authoring roles are creating DITA today in your organization? (multiple-select list, option to provide example url for each one selected, option to provide examples of content types for each one selected) - Designers - Developers - Marketing authors - Salespeople - Product documentation authors - Embedded assistance authors - Trainers - Support - Subject experts - Internal policy/procedure authors - Other 3 - Which content areas are you considering Lightweight DITA for? (same list as above, with same options) 4 - What source formats are important for your use of LW DITA? XML Markdown HTML JSON Word Other (write-in) 5 - What delivery formats are important for your use of LW DITA? HTML PDF EPUB JSON Word Other (write-in) 6 - Is anything missing from the following list of block-level elements in LW DITA? p ul ol dl pre audio video simpletable fig note fn [write-in field after showing the above] 7 - If you are planning to specialize, which of the following capabilities are must-haves? - nesting div structures for deep containment specializations - base attribute for arbitrary attribute definition - multiple-level specialization (ability to specialize off other specializations, not just topic) 8 - Which of the following benefits/features of LW DITA matter to you? - Simpler XML authoring - HTML5 authoring - Markdown authoring - Easier specialization - Easier tools development - Cross-silo content sharing - Cross-silo tool sharing - Other (write-in) 9 - is it ok to contact you for followup? email address Michael Priestley, Senior Technical Staff Member (STSM) Enterprise Content Technology Strategist mpriestl@ca.ibm.com http://dita.xml.org/blog/michael-priestley


  • 2.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 06-21-2016 00:48
      |   view attached
    Hi Michael (and all), Thanks for starting this.I have a few notes and observations here as we prepare for Monday’s call. - Do we want to collect any demographic information before getting into the core Lightweight DITA questions? - For #1, how about instead of giving an external link we write  a concise (couple of paragraphs) definition of Lightweight DITA borrowing from your original blog post, our STC article, and the DITA NA presentations? I am happy to work on a draft of it and share.  - For #2 and #3, do you mean we are providing the optional examples or we are expecting them to provide their examples? - For #2 and #3, add translators to list. - For #6, provide descriptions/definitions of each tag. - For  #7, maybe use your example o Attachment: eviasharpperez.pdf Description: Adobe PDF document f to-dos from the DITA NA slides to explain Lightweight DITA specialization. After Monday’s call I can work on this with input from the SC. Like I mentioned before, this is very relevant to my current research project (expanding my analysis of DITA through Computational Thinking; IEEE paper published last fall attached to this message for information/entertainment of SC’s members who have not seen it), so I can put some time into it. And we can host it in Virginia Tech’s Qualtrics survey implementation. Looking forward to Monday’s call. Carlos --  Carlos Evia, Ph.D. Director of Professional and Technical Writing Associate Professor of Technical Communication Department of English Center for Human-Computer Interaction Virginia Tech Blacksburg, VA 24061-0112 (540)200-8201 On Jun 20, 2016, at 4:11 PM, Michael Priestley < mpriestl@ca.ibm.com > wrote: How about this for dita-users: 1 - link to overview/description of lightweight DITA for them to review first 2 - Which of the following authoring roles are creating DITA today in your organization? (multiple-select list, option to provide example url for each one selected, option to provide examples of content types for each one selected) - Designers - Developers - Marketing authors - Salespeople - Product documentation authors - Embedded assistance authors - Trainers - Support - Subject experts - Internal policy/procedure authors - Other 3 - Which content areas are you considering Lightweight DITA for? (same list as above, with same options) 4 - What source formats are important for your use of LW DITA? XML Markdown HTML JSON Word Other (write-in) 5 - What delivery formats are important for your use of LW DITA? HTML PDF EPUB JSON Word Other (write-in) 6 - Is anything missing from the following list of block-level elements in LW DITA? p ul ol dl pre audio video simpletable fig note fn [write-in field after showing the above] 7 - If you are planning to specialize, which of the following capabilities are must-haves? - nesting div structures for deep containment specializations - base attribute for arbitrary attribute definition - multiple-level specialization (ability to specialize off other specializations, not just topic) 8 - Which of the following benefits/features of LW DITA matter to you? - Simpler XML authoring - HTML5 authoring - Markdown authoring - Easier specialization - Easier tools development - Cross-silo content sharing - Cross-silo tool sharing - Other (write-in) 9 - is it ok to contact you for followup? email address Michael Priestley, Senior Technical Staff Member (STSM) Enterprise Content Technology Strategist mpriestl@ca.ibm.com http://dita.xml.org/blog/michael-priestley

    Attachment(s)

    pdf
    eviasharpperez.pdf   450 KB 1 version


  • 3.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 06-21-2016 17:30
    Hi Carlos, For #1 - sounds good - maybe still worth including the link as well, for those willing to spend the time on it, but shouldn't be a prereq for the survey For 2 and 3 - I was thinking they'd be providing examples, of the content they're currently publishing from DITA or want to publish from DITA. And ok by me to add translators. For 6 - agreed For 7 - ok - need to make this part easy to skip for folks who aren't interested in/familiar with specialization Michael Priestley, Senior Technical Staff Member (STSM) Enterprise Content Technology Strategist mpriestl@ca.ibm.com http://dita.xml.org/blog/michael-priestley From:         Carlos Evia <cevia@vt.edu> To:         Michael Priestley/Toronto/IBM@IBMCA, dita-lightweight-dita@lists.oasis-open.org Date:         06/20/2016 08:48 PM Subject:         Re: [dita-lightweight-dita] Thoughts on a survey Sent by:         <dita-lightweight-dita@lists.oasis-open.org> Hi Michael (and all), Thanks for starting this.I have a few notes and observations here as we prepare for Monday’s call. - Do we want to collect any demographic information before getting into the core Lightweight DITA questions? - For #1, how about instead of giving an external link we write  a concise (couple of paragraphs) definition of Lightweight DITA borrowing from your original blog post, our STC article, and the DITA NA presentations? I am happy to work on a draft of it and share. - For #2 and #3, do you mean we are providing the optional examples or we are expecting them to provide their examples? - For #2 and #3, add translators to list. - For #6, provide descriptions/definitions of each tag. - For  #7, maybe use your example of to-dos from the DITA NA slides to explain Lightweight DITA specialization. After Monday’s call I can work on this with input from the SC. Like I mentioned before, this is very relevant to my current research project (expanding my analysis of DITA through Computational Thinking; IEEE paper published last fall attached to this message for information/entertainment of SC’s members who have not seen it), so I can put some time into it. And we can host it in Virginia Tech’s Qualtrics survey implementation. Looking forward to Monday’s call. Carlos -- Carlos Evia, Ph.D. Director of Professional and Technical Writing Associate Professor of Technical Communication Department of English Center for Human-Computer Interaction Virginia Tech Blacksburg, VA 24061-0112 (540)200-8201 On Jun 20, 2016, at 4:11 PM, Michael Priestley < mpriestl@ca.ibm.com > wrote: How about this for dita-users: 1 - link to overview/description of lightweight DITA for them to review first 2 - Which of the following authoring roles are creating DITA today in your organization? (multiple-select list, option to provide example url for each one selected, option to provide examples of content types for each one selected) - Designers - Developers - Marketing authors - Salespeople - Product documentation authors - Embedded assistance authors - Trainers - Support - Subject experts - Internal policy/procedure authors - Other 3 - Which content areas are you considering Lightweight DITA for? (same list as above, with same options) 4 - What source formats are important for your use of LW DITA? XML Markdown HTML JSON Word Other (write-in) 5 - What delivery formats are important for your use of LW DITA? HTML PDF EPUB JSON Word Other (write-in) 6 - Is anything missing from the following list of block-level elements in LW DITA? p ul ol dl pre audio video simpletable fig note fn [write-in field after showing the above] 7 - If you are planning to specialize, which of the following capabilities are must-haves? - nesting div structures for deep containment specializations - base attribute for arbitrary attribute definition - multiple-level specialization (ability to specialize off other specializations, not just topic) 8 - Which of the following benefits/features of LW DITA matter to you? - Simpler XML authoring - HTML5 authoring - Markdown authoring - Easier specialization - Easier tools development - Cross-silo content sharing - Cross-silo tool sharing - Other (write-in) 9 - is it ok to contact you for followup? email address Michael Priestley, Senior Technical Staff Member (STSM) Enterprise Content Technology Strategist mpriestl@ca.ibm.com http://dita.xml.org/blog/michael-priestley


  • 4.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 06-28-2016 17:35
    I reviewed the survey and cleaned it up a bit. Here's what I came up with: The Lightweight DITA committee wants to understand more about how DITA is, and could be, used inside of organisations to manage their content more efficiently and get more benefit from their content.   Using DITA allows users to [fill in here with description of lightweight DITA]   Which of the following  roles are creating DITA today in your organization? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you now produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)   In which content areas are you considering Lightweight DITA? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you would like to produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)     What authoring tools do you use to write your content in Lightweight DITA? Help Authoring Tool (if so, which one) HTML editor JSON Markdown Microsoft Word XML editor Other (specify)   What delivery formats are important for your use of LW DITA? ePub HTML JSON Microsoft Word PDF XML Other (specify)   6 - Lightweight DITA has the following "block-level" elements [plain English definition]. Are there are elements that you would consider important to be missing from this list? Figure [fig] Footnote [fn] List - Definition [dl] List - Ordered (numbered [ol] List - Unordered (bulleted) [ul] Multimedia - Audio [audio] Multimedia - Video [video] Note [note] Paragraph [p] Prerequisite statement [pre] Table - Simple [simpletable]   [Add any missing elements.]   Some organisations may want to specialize (customise) Lightweight DITA for their specific content needs. If you plan to specialize, which of the following capabilities are must-haves? Being able to have containers within containers? (Nested div structures for deep containment specializations) The ability to choose which attributes you add to content? (Base attributes for arbitrary attribute definition) The ability to re-use a central specialization (Multiple-level specialization - the ability to specialize off other specializations, not just topic)    Which of the following benefits/features of LW DITA matter to you? Simpler XML authoring HTML5 authoring Markdown authoring Easier specialization Easier tools development Cross-silo content sharing Cross-silo tool sharing Other (specify)   If we have questions or want more information about your answer, could we contact you to followup? If so, please provide an email address.


  • 5.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 06-28-2016 17:45
    Nothing in here about deliverable types? e.g. are you making brochures, datasheets, intranet content, product descriptions, catalogs, white papers, app content, augmented reality, etc...? On 28 June 2016 at 18:34, Rahel Anne Bailie < rahel.bailie@gmail.com > wrote: I reviewed the survey and cleaned it up a bit. Here's what I came up with: The Lightweight DITA committee wants to understand more about how DITA is, and could be, used inside of organisations to manage their content more efficiently and get more benefit from their content.   Using DITA allows users to [fill in here with description of lightweight DITA]   Which of the following  roles are creating DITA today in your organization? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you now produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)   In which content areas are you considering Lightweight DITA? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you would like to produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)     What authoring tools do you use to write your content in Lightweight DITA? Help Authoring Tool (if so, which one) HTML editor JSON Markdown Microsoft Word XML editor Other (specify)   What delivery formats are important for your use of LW DITA? ePub HTML JSON Microsoft Word PDF XML Other (specify)   6 - Lightweight DITA has the following "block-level" elements [plain English definition]. Are there are elements that you would consider important to be missing from this list? Figure [fig] Footnote [fn] List - Definition [dl] List - Ordered (numbered [ol] List - Unordered (bulleted) [ul] Multimedia - Audio [audio] Multimedia - Video [video] Note [note] Paragraph [p] Prerequisite statement [pre] Table - Simple [simpletable]   [Add any missing elements.]   Some organisations may want to specialize (customise) Lightweight DITA for their specific content needs. If you plan to specialize, which of the following capabilities are must-haves? Being able to have containers within containers? (Nested div structures for deep containment specializations) The ability to choose which attributes you add to content? (Base attributes for arbitrary attribute definition) The ability to re-use a central specialization (Multiple-level specialization - the ability to specialize off other specializations, not just topic)    Which of the following benefits/features of LW DITA matter to you? Simpler XML authoring HTML5 authoring Markdown authoring Easier specialization Easier tools development Cross-silo content sharing Cross-silo tool sharing Other (specify)   If we have questions or want more information about your answer, could we contact you to followup? If so, please provide an email address. -- Noz Content Strategist, www.urbinaconsulting.com Co-Author of "Content Strategy: Connecting the dots between business, brand and benefits", www.thecontentstrategybook.com Landline +34 961 051 460 Mobile +34 625 467 866


  • 6.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 06-30-2016 01:08
    I was concerned about size/effort here - each of the authoring roles probably have a dozen or so potential content or deliverable types associated with them. I don't have a list handy of what they would be. We've got some info on type of content as part of the authoring role  - like "policy and procedure author", "embedded assistance author" - and there's also the question about source and delivery formats later on. If you'd prefer to ask a different way (or have more questions you want added), take a swing! Michael Priestley, Senior Technical Staff Member (STSM) Enterprise Content Technology Strategist mpriestl@ca.ibm.com From:         Noz Urbina <noz.urbina@urbinaconsulting.com> To:         Rahel Anne Bailie <rahel.bailie@gmail.com> Cc:         Michael Priestley/Toronto/IBM@IBMCA, dita-lightweight-dita@lists.oasis-open.org Date:         06/28/2016 01:45 PM Subject:         Re: [dita-lightweight-dita] Thoughts on a survey Sent by:         <dita-lightweight-dita@lists.oasis-open.org> Nothing in here about deliverable types? e.g. are you making brochures, datasheets, intranet content, product descriptions, catalogs, white papers, app content, augmented reality, etc...? On 28 June 2016 at 18:34, Rahel Anne Bailie < rahel.bailie@gmail.com > wrote: I reviewed the survey and cleaned it up a bit. Here's what I came up with: The Lightweight DITA committee wants to understand more about how DITA is, and could be, used inside of organisations to manage their content more efficiently and get more benefit from their content.   Using DITA allows users to [fill in here with description of lightweight DITA]   1.         Which of the following  roles are creating DITA today in your organization? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you now produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)   2.         In which content areas are you considering Lightweight DITA? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you would like to produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)     3.         What authoring tools do you use to write your content in Lightweight DITA? Help Authoring Tool (if so, which one) HTML editor JSON Markdown Microsoft Word XML editor Other (specify)   4.         What delivery formats are important for your use of LW DITA? ePub HTML JSON Microsoft Word PDF XML Other (specify)   6 - Lightweight DITA has the following "block-level" elements [plain English definition]. Are there are elements that you would consider important to be missing from this list? Figure [fig] Footnote [fn] List - Definition [dl] List - Ordered (numbered [ol] List - Unordered (bulleted) [ul] Multimedia - Audio [audio] Multimedia - Video [video] Note [note] Paragraph [p] Prerequisite statement [pre] Table - Simple [simpletable]   [Add any missing elements.]   7.         Some organisations may want to specialize (customise) Lightweight DITA for their specific content needs. If you plan to specialize, which of the following capabilities are must-haves? Being able to have containers within containers? (Nested div structures for deep containment specializations) The ability to choose which attributes you add to content? (Base attributes for arbitrary attribute definition) The ability to re-use a central specialization (Multiple-level specialization - the ability to specialize off other specializations, not just topic)    8.         Which of the following benefits/features of LW DITA matter to you? Simpler XML authoring HTML5 authoring Markdown authoring Easier specialization Easier tools development Cross-silo content sharing Cross-silo tool sharing Other (specify)   9.         If we have questions or want more information about your answer, could we contact you to followup? If so, please provide an email address. -- Noz Content Strategist, www.urbinaconsulting.com Co-Author of "Content Strategy: Connecting the dots between business, brand and benefits", www.thecontentstrategybook.com Landline +34 961 051 460 Mobile +34 625 467 866


  • 7.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 07-04-2016 11:03
    I don't think a "comprehensive list" is even possible, so I don't think we should worry about completeness. If we took 4 from each domain area that would already really help confirm our focus.  I suggest each sub-sub-comittee suggest the top ones they were holding up as a reference. If those are off the mark then we should know. On 30 Jun 2016 03:07, "Michael Priestley" < mpriestl@ca.ibm.com > wrote: I was concerned about size/effort here - each of the authoring roles probably have a dozen or so potential content or deliverable types associated with them. I don't have a list handy of what they would be. We've got some info on type of content as part of the authoring role  - like "policy and procedure author", "embedded assistance author" - and there's also the question about source and delivery formats later on. If you'd prefer to ask a different way (or have more questions you want added), take a swing! Michael Priestley, Senior Technical Staff Member (STSM) Enterprise Content Technology Strategist mpriestl@ca.ibm.com From:         Noz Urbina < noz.urbina@urbinaconsulting.com > To:         Rahel Anne Bailie < rahel.bailie@gmail.com > Cc:         Michael Priestley/Toronto/IBM@IBMCA, dita-lightweight-dita@lists.oasis-open.org Date:         06/28/2016 01:45 PM Subject:         Re: [dita-lightweight-dita] Thoughts on a survey Sent by:         < dita-lightweight-dita@lists.oasis-open.org > Nothing in here about deliverable types? e.g. are you making brochures, datasheets, intranet content, product descriptions, catalogs, white papers, app content, augmented reality, etc...? On 28 June 2016 at 18:34, Rahel Anne Bailie < rahel.bailie@gmail.com > wrote: I reviewed the survey and cleaned it up a bit. Here's what I came up with: The Lightweight DITA committee wants to understand more about how DITA is, and could be, used inside of organisations to manage their content more efficiently and get more benefit from their content.   Using DITA allows users to [fill in here with description of lightweight DITA]   1.         Which of the following  roles are creating DITA today in your organization? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you now produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)   2.         In which content areas are you considering Lightweight DITA? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you would like to produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)     3.         What authoring tools do you use to write your content in Lightweight DITA? Help Authoring Tool (if so, which one) HTML editor JSON Markdown Microsoft Word XML editor Other (specify)   4.         What delivery formats are important for your use of LW DITA? ePub HTML JSON Microsoft Word PDF XML Other (specify)   6 - Lightweight DITA has the following "block-level" elements [plain English definition]. Are there are elements that you would consider important to be missing from this list? Figure [fig] Footnote [fn] List - Definition [dl] List - Ordered (numbered [ol] List - Unordered (bulleted) [ul] Multimedia - Audio [audio] Multimedia - Video [video] Note [note] Paragraph [p] Prerequisite statement [pre] Table - Simple [simpletable]   [Add any missing elements.]   7.         Some organisations may want to specialize (customise) Lightweight DITA for their specific content needs. If you plan to specialize, which of the following capabilities are must-haves? Being able to have containers within containers? (Nested div structures for deep containment specializations) The ability to choose which attributes you add to content? (Base attributes for arbitrary attribute definition) The ability to re-use a central specialization (Multiple-level specialization - the ability to specialize off other specializations, not just topic)    8.         Which of the following benefits/features of LW DITA matter to you? Simpler XML authoring HTML5 authoring Markdown authoring Easier specialization Easier tools development Cross-silo content sharing Cross-silo tool sharing Other (specify)   9.         If we have questions or want more information about your answer, could we contact you to followup? If so, please provide an email address. -- Noz Content Strategist, www.urbinaconsulting.com Co-Author of "Content Strategy: Connecting the dots between business, brand and benefits", www.thecontentstrategybook.com Landline +34 961 051 460 Mobile +34 625 467 866


  • 8.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 06-28-2016 18:34
    The wording of several questions in this survey speaks to current users of LW-DITA, of which there will not be too many, as we are still in a concept phase of defining it. To get input from areas that we hope to be targeting with LW-DITA, this should be changed to address their current practice and ask what advantages they would expect from using LW-DITA. Depending on the target audience for the survey, an introduction about DITA vs LW-DITA might or might not be relevant. Question 3 seems to lean toward a community that is currently using other lightweight content solutions, but asks which tools are being used to create LW-DITA content. I would expect not a single option to be checked by anyone. The question seems to ask which tools are currently used to create the type of content that could be authored in LW-DITA, but as hardly anyone knows LW-DITA that should be described in a different manner. JSON should be removed from the list of authoring tools in any case, as it is a format, not a tool. Apart from these general remarks, I believe there is at least one error in the elements listed for question 6. The [pre] element is Preformatted text. If Prerequisite is meant, it should be [prereq], but I don't think that is one of the basic block elements for generic authoring. My 2 cents. Op 28 juni 2016 19:34:30 +02:00, schreef : I reviewed the survey and cleaned it up a bit. Here's what I came up with: The Lightweight DITA committee wants to understand more about how DITA is, and could be, used inside of organisations to manage their content more efficiently and get more benefit from their content.   Using DITA allows users to [fill in here with description of lightweight DITA]   Which of the following  roles are creating DITA today in your organization? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you now produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)   In which content areas are you considering Lightweight DITA? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you would like to produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)     What authoring tools do you use to write your content in Lightweight DITA? Help Authoring Tool (if so, which one) HTML editor JSON Markdown Microsoft Word XML editor Other (specify)   What delivery formats are important for your use of LW DITA? ePub HTML JSON Microsoft Word PDF XML Other (specify)   6 - Lightweight DITA has the following block-level elements [plain English definition]. Are there are elements that you would consider important to be missing from this list? Figure [fig] Footnote [fn] List - Definition [dl] List - Ordered (numbered [ol] List - Unordered (bulleted) [ul] Multimedia - Audio [audio] Multimedia - Video [video] Note [note] Paragraph [p] Prerequisite statement [pre] Table - Simple [simpletable]   [Add any missing elements.]   Some organisations may want to specialize (customise) Lightweight DITA for their specific content needs. If you plan to specialize, which of the following capabilities are must-haves? Being able to have containers within containers? (Nested div structures for deep containment specializations) The ability to choose which attributes you add to content? (Base attributes for arbitrary attribute definition) The ability to re-use a central specialization (Multiple-level specialization - the ability to specialize off other specializations, not just topic)    Which of the following benefits/features of LW DITA matter to you? Simpler XML authoring HTML5 authoring Markdown authoring Easier specialization Easier tools development Cross-silo content sharing Cross-silo tool sharing Other (specify)   If we have questions or want more information about your answer, could we contact you to followup? If so, please provide an email address.


  • 9.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 06-28-2016 18:55
    Very good observation about number 3: no one is using Lightweight DITA now (other than my students and Stan Doherty’s friends) I believe the original question was something like “what forms of input would be important for you when considering LW-DITA. Carlos - --  Carlos Evia, Ph.D. Director of Professional and Technical Writing Associate Professor of Technical Communication Department of English Center for Human-Computer Interaction Virginia Tech Blacksburg, VA 24061-0112 (540)200-8201 On Jun 28, 2016, at 2:33 PM, < jang@jang.nl > < jang@jang.nl > wrote: The wording of several questions in this survey speaks to current users of LW-DITA, of which there will not be too many, as we are still in a concept phase of defining it. To get input from areas that we hope to be targeting with LW-DITA, this should be changed to address their current practice and ask what advantages they would expect from using LW-DITA. Depending on the target audience for the survey, an introduction about DITA vs LW-DITA might or might not be relevant. Question 3 seems to lean toward a community that is currently using other lightweight content solutions, but asks which tools are being used to create LW-DITA content. I would expect not a single option to be checked by anyone. The question seems to ask which tools are currently used to create the type of content that could be authored in LW-DITA, but as hardly anyone knows LW-DITA that should be described in a different manner. JSON should be removed from the list of authoring tools in any case, as it is a format, not a tool. Apart from these general remarks, I believe there is at least one error in the elements listed for question 6. The [pre] element is Preformatted text. If Prerequisite is meant, it should be [prereq], but I don't think that is one of the basic block elements for generic authoring. My 2 cents. Op 28 juni 2016 19:34:30 +02:00, schreef : I reviewed the survey and cleaned it up a bit. Here's what I came up with: The Lightweight DITA committee wants to understand more about how DITA is, and could be, used inside of organisations to manage their content more efficiently and get more benefit from their content.   Using DITA allows users to [fill in here with description of lightweight DITA]   Which of the following  roles are creating DITA today in your organization? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you now produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)   In which content areas are you considering Lightweight DITA? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you would like to produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)     What authoring tools do you use to write your content in Lightweight DITA? Help Authoring Tool (if so, which one) HTML editor JSON Markdown Microsoft Word XML editor Other (specify)   What delivery formats are important for your use of LW DITA? ePub HTML JSON Microsoft Word PDF XML Other (specify)   6 - Lightweight DITA has the following block-level elements [plain English definition]. Are there are elements that you would consider important to be missing from this list? Figure [fig] Footnote [fn] List - Definition [dl] List - Ordered (numbered [ol] List - Unordered (bulleted) [ul] Multimedia - Audio [audio] Multimedia - Video [video] Note [note] Paragraph [p] Prerequisite statement [pre] Table - Simple [simpletable]   [Add any missing elements.]   Some organisations may want to specialize (customise) Lightweight DITA for their specific content needs. If you plan to specialize, which of the following capabilities are must-haves? Being able to have containers within containers? (Nested div structures for deep containment specializations) The ability to choose which attributes you add to content? (Base attributes for arbitrary attribute definition) The ability to re-use a central specialization (Multiple-level specialization - the ability to specialize off other specializations, not just topic)    Which of the following benefits/features of LW DITA matter to you? Simpler XML authoring HTML5 authoring Markdown authoring Easier specialization Easier tools development Cross-silo content sharing Cross-silo tool sharing Other (specify)   If we have questions or want more information about your answer, could we contact you to followup? If so, please provide an email address.


  • 10.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 06-30-2016 01:16
    Hi Jang, We need to be clear that we're asking both existing users of DITA (not currently LWDITA), and potential users of DITA (especially LWDITA). We do ask about potential benefits in question 8, although definitely open to identifying/asking for more. The first question is for existing users, the second for potential users. I think really all of the questions except for the first one are meant to be about current (and presumably mostly non-DITA) practice. Question 3 shouldn't mention LWDITA at all - I think it was originally about source format, and it's now a mix of source formats and editor tools - we need to go with one or the other. It sort of depends on survey audience - developers might be more comfortable answering the format question (which is one I do care about - especially knowing if we have JSON to deal with), authors will be more comfortable with the tool question. Agreed on the mistake in block elements - <pre> is preformatted text, not prerequisites. Good catch. Michael Priestley, Senior Technical Staff Member (STSM) Enterprise Content Technology Strategist mpriestl@ca.ibm.com From:         <jang@jang.nl> To:         Cc:         <dita-lightweight-dita@lists.oasis-open.org> Date:         06/28/2016 02:34 PM Subject:         Re: [dita-lightweight-dita] Thoughts on a survey Sent by:         <dita-lightweight-dita@lists.oasis-open.org> The wording of several questions in this survey speaks to current users of LW-DITA, of which there will not be too many, as we are still in a concept phase of defining it. To get input from areas that we hope to be targeting with LW-DITA, this should be changed to address their current practice and ask what advantages they would expect from using LW-DITA. Depending on the target audience for the survey, an introduction about DITA vs LW-DITA might or might not be relevant. Question 3 seems to lean toward a community that is currently using other lightweight content solutions, but asks which tools are being used to create LW-DITA content. I would expect not a single option to be checked by anyone. The question seems to ask which tools are currently used to create the type of content that could be authored in LW-DITA, but as hardly anyone knows LW-DITA that should be described in a different manner. JSON should be removed from the list of authoring tools in any case, as it is a format, not a tool. Apart from these general remarks, I believe there is at least one error in the elements listed for question 6. The [pre] element is Preformatted text. If Prerequisite is meant, it should be [prereq], but I don't think that is one of the basic block elements for generic authoring. My 2 cents. Op 28 juni 2016 19:34:30 +02:00, schreef : I reviewed the survey and cleaned it up a bit. Here's what I came up with: The Lightweight DITA committee wants to understand more about how DITA is, and could be, used inside of organisations to manage their content more efficiently and get more benefit from their content.   Using DITA allows users to [fill in here with description of lightweight DITA]   1.         Which of the following  roles are creating DITA today in your organization? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you now produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)   2.         In which content areas are you considering Lightweight DITA? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you would like to produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)     3.         What authoring tools do you use to write your content in Lightweight DITA? Help Authoring Tool (if so, which one) HTML editor JSON Markdown Microsoft Word XML editor Other (specify)   4.         What delivery formats are important for your use of LW DITA? ePub HTML JSON Microsoft Word PDF XML Other (specify)   6 - Lightweight DITA has the following "block-level" elements [plain English definition]. Are there are elements that you would consider important to be missing from this list? Figure [fig] Footnote [fn] List - Definition [dl] List - Ordered (numbered [ol] List - Unordered (bulleted) [ul] Multimedia - Audio [audio] Multimedia - Video [video] Note [note] Paragraph [p] Prerequisite statement [pre] Table - Simple [simpletable]   [Add any missing elements.]   7.         Some organisations may want to specialize (customise) Lightweight DITA for their specific content needs. If you plan to specialize, which of the following capabilities are must-haves? Being able to have containers within containers? (Nested div structures for deep containment specializations) The ability to choose which attributes you add to content? (Base attributes for arbitrary attribute definition) The ability to re-use a central specialization (Multiple-level specialization - the ability to specialize off other specializations, not just topic)    8.         Which of the following benefits/features of LW DITA matter to you? Simpler XML authoring HTML5 authoring Markdown authoring Easier specialization Easier tools development Cross-silo content sharing Cross-silo tool sharing Other (specify)   9.         If we have questions or want more information about your answer, could we contact you to followup? If so, please provide an email address.


  • 11.  Re: [dita-lightweight-dita] Thoughts on a survey

    Posted 06-30-2016 08:49
    Thanks for the extra info about the intended audiences. I am hoping this survey will be done in the proper way, i.e. using one of the free online survey tools, rather than sending them in e-mails. Given that assumption, it would be a good idea to have a first question determine whether respondents know anything about DITA or not. If not, we need not ask them about DITA in their organisation and should not refer to the DITA name but instead ask for the tools and formats they are currently using to create product documentation and/or marketing materials. If I am a casual author and I see questions about some acronym I do not even know, I will quickly decide this survey is not for me. And I am wild guessing that for us the responses of these casual authors would be more interesting than the ones from DITA-savvy authors (who do not need LWDITA themselves but are imagining what others in their organization might want or need). In fact, the survey should be designed to have clear and separate paths. Asking questions that are irrelevant based on earlier answers is deadly for the enthusiasm of a respondent. Op 30 juni 2016 03:15:24 +02:00, schreef Michael Priestley <mpriestl@ca.ibm.com>: Hi Jang, We need to be clear that we're asking both existing users of DITA (not currently LWDITA), and potential users of DITA (especially LWDITA). We do ask about potential benefits in question 8, although definitely open to identifying/asking for more. The first question is for existing users, the second for potential users. I think really all of the questions except for the first one are meant to be about current (and presumably mostly non-DITA) practice. Question 3 shouldn't mention LWDITA at all - I think it was originally about source format, and it's now a mix of source formats and editor tools - we need to go with one or the other. It sort of depends on survey audience - developers might be more comfortable answering the format question (which is one I do care about - especially knowing if we have JSON to deal with), authors will be more comfortable with the tool question. Agreed on the mistake in block elements - <pre> is preformatted text, not prerequisites. Good catch. Michael Priestley, Senior Technical Staff Member (STSM) Enterprise Content Technology Strategist mpriestl@ca.ibm.com From:         <jang@jang.nl> To:         Cc:         <dita-lightweight-dita@lists.oasis-open.org> Date:         06/28/2016 02:34 PM Subject:         Re: [dita-lightweight-dita] Thoughts on a survey Sent by:         <dita-lightweight-dita@lists.oasis-open.org> The wording of several questions in this survey speaks to current users of LW-DITA, of which there will not be too many, as we are still in a concept phase of defining it. To get input from areas that we hope to be targeting with LW-DITA, this should be changed to address their current practice and ask what advantages they would expect from using LW-DITA. Depending on the target audience for the survey, an introduction about DITA vs LW-DITA might or might not be relevant. Question 3 seems to lean toward a community that is currently using other lightweight content solutions, but asks which tools are being used to create LW-DITA content. I would expect not a single option to be checked by anyone. The question seems to ask which tools are currently used to create the type of content that could be authored in LW-DITA, but as hardly anyone knows LW-DITA that should be described in a different manner. JSON should be removed from the list of authoring tools in any case, as it is a format, not a tool. Apart from these general remarks, I believe there is at least one error in the elements listed for question 6. The [pre] element is Preformatted text. If Prerequisite is meant, it should be [prereq], but I don't think that is one of the basic block elements for generic authoring. My 2 cents. Op 28 juni 2016 19:34:30 +02:00, schreef : I reviewed the survey and cleaned it up a bit. Here's what I came up with: The Lightweight DITA committee wants to understand more about how DITA is, and could be, used inside of organisations to manage their content more efficiently and get more benefit from their content.   Using DITA allows users to [fill in here with description of lightweight DITA]   1.         Which of the following  roles are creating DITA today in your organization? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you now produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)   2.         In which content areas are you considering Lightweight DITA? Choose as many options as apply. If possible, point us to an example by providing a URL for each type of content you would like to produce using DITA.   [will need to have clearly-indicated field for URLs or comments] Content designers Content developers Content editors Customer support staff Embedded assistance authors Help/UA authors Marketing communicators Policy and procedure authors Product documentation authors Sales people Trainers - Non-technical Trainers - technical Software Designers Software Developers Support staff (Pas) Subject matter experts - non-technical (eg marketing) Subject matter experts - technical Other (specify)     3.         What authoring tools do you use to write your content in Lightweight DITA? Help Authoring Tool (if so, which one) HTML editor JSON Markdown Microsoft Word XML editor Other (specify)   4.         What delivery formats are important for your use of LW DITA? ePub HTML JSON Microsoft Word PDF XML Other (specify)   6 - Lightweight DITA has the following block-level elements [plain English definition]. Are there are elements that you would consider important to be missing from this list? Figure [fig] Footnote [fn] List - Definition [dl] List - Ordered (numbered [ol] List - Unordered (bulleted) [ul] Multimedia - Audio [audio] Multimedia - Video [video] Note [note] Paragraph [p] Prerequisite statement [pre] Table - Simple [simpletable]   [Add any missing elements.]   7.         Some organisations may want to specialize (customise) Lightweight DITA for their specific content needs. If you plan to specialize, which of the following capabilities are must-haves? Being able to have containers within containers? (Nested div structures for deep containment specializations) The ability to choose which attributes you add to content? (Base attributes for arbitrary attribute definition) The ability to re-use a central specialization (Multiple-level specialization - the ability to specialize off other specializations, not just topic)    8.         Which of the following benefits/features of LW DITA matter to you? Simpler XML authoring HTML5 authoring Markdown authoring Easier specialization Easier tools development Cross-silo content sharing Cross-silo tool sharing Other (specify)   9.         If we have questions or want more information about your answer, could we contact you to followup? If so, please provide an email address.