Module Details

Module Code: SOFT9020
Title: XML in Technical Communication
Long Title: XML in Technical Communications
NFQ Level: Expert
Valid From: Semester 1 - 2024/25 ( September 2024 )
Duration: 1 Semester
Credits: 10
Field of Study: 4814 - Computer Software
Module Delivered in: 2 programme(s)
Module Description: Extensible Markup Language (XML) has had a huge impact on software development, data representation and interchange, and its application in the field of technical communications is now growing in importance. XML provides a platform-independent and vendor-neutral method for creating and publishing documentation that can be easily transformed into a variety of output formats. As Industry 5.0 brings new dimensions to the field, it is important to understand XML-based authoring in the context of Intelligent Content, Information Architecture and Information Management. This module aims to develop students’ skills in XML and, in particular, Darwin Information Typing Architecture (DITA), which is an XML language designed specifically for technical communications and DocBook.
 
Learning Outcomes
On successful completion of this module the learner will be able to:
# Learning Outcome Description
LO1 Experiment the main technologies involved in technical communications which include XML, XSLT stylesheets, DTD and XSD.
LO2 Determine best practices, and conventions for industry standard authoring approaches.
LO3 Design technical documentation for re-usability.
LO4 Organise content based on content models and information architecture.
LO5 Create documents based on the nature of the content.
LO6 Generate content to a variety of output formats.
Dependencies
Module Recommendations

This is prior learning (or a practical skill) that is strongly recommended before enrolment in this module. You may enrol in this module if you have not acquired the recommended learning but you will have considerable difficulty in passing (i.e. achieving the learning outcomes of) the module. While the prior learning is expressed as named MTU module(s) it also allows for learning (in another module or modules) which is equivalent to the learning specified in the named module(s).
Incompatible Modules
These are modules which have learning outcomes that are too similar to the learning outcomes of this module. You may not earn additional credit for the same learning and therefore you may not enrol in this module if you have successfully completed any modules in the incompatible list.
No incompatible modules listed
Co-requisite Modules
No Co-requisite modules listed
Requirements

This is prior learning (or a practical skill) that is mandatory before enrolment in this module is allowed. You may not enrol on this module if you have not acquired the learning specified in this section.
No requirements listed
 
Indicative Content
XML
Introduction to XML. Advantages of using XML in technical communications. Application areas of XML. Comparison of XML to HTML. Well-formed and valid XML documents. XML declarations and Document Type Declarations. XML language components i.e. elements, attributes, entities and declarations. XML technologies such as DTD, XSLT, XSL-FO, XPath. XML toolkits and editors. Stylesheet technologies, customisation, and automated approaches to Stylesheet generation.
DITA
Introduction to DITA. History of DITA. DITA 1.2 specification. Understanding DITA essentials: topics, information typing, separation of content from presentation, specialization.
Authoring in DITA
Topic based authoring. Task, concept and reference topics. Arranging topics into DITA maps. Publishing to output formats i.e. PDF, HTML etc.
DITA and Content Reuse
Single sourcing. Reusing topics and maps. Reusing portions of content from a topic in another topic. Pushing a portion of content of content from a topic into another topic. Profiling and filtering content. Conditional Processing. Linking in DITA. Linking methods. Inline cross-references and related links. Cross references using relationship tables. Best practices in cross-references. Indirection methods.
Customisation using XSLT stylesheets
General customisation include: Cover page customisation; Titles; body text; text formatting; lists; fonts and attribute sets. Header and Footer Customisation: Header and Footer formatting; margin; format and justify; adding additional information and logos. Page masters Customisation: Default page masters and attribute sets; setting a page dimension; margins; body; and header and footer regions. Design of front cover page. Add background image to page. Change column numbers of master page. Landscape pages.
Document creation, translation and localisation, and publishing
XML for writing documents and books related to different topics. Authoring by DocBook and using its features. Typical content management workflows, from planning, and authoring through to translation and localization, publishing and QA.
Information Architecture and Content Modelling
Introduction to Information Architecture and its significance in XML-based technical communications. The relationship between Information Typing and Content Modelling. Best practices for XML-based authoring, including information management, content strategy and content maintenance.
Module Content & Assessment
Assessment Breakdown%
Coursework100.00%

Assessments

Coursework
Assessment Type Project % of Total Mark 30
Timing Week 6 Learning Outcomes 1,2,3,4
Assessment Description
Create content models and develop a basic Information management and architecture strategy for an unstructured technical document that needs to be migrated to an XML-based authoring standard.
Assessment Type Project % of Total Mark 25
Timing Every Second Week Learning Outcomes 2,3,4,5,6
Assessment Description
Participate in required online discussions based on assigned topics to demonstrate an understanding and exploration of learning outcomes.
Assessment Type Project % of Total Mark 45
Timing Sem End Learning Outcomes 2,3,4,5,6
Assessment Description
Create and author a document using core XML/DITA skills demonstrating best practices in link and dependency management, filtering and conditional processing.
No End of Module Formal Examination
Reassessment Requirement
Coursework Only
This module is reassessed solely on the basis of re-submitted coursework. There is no repeat written examination.

The University reserves the right to alter the nature and timings of assessment

 

Module Workload

Workload: Full Time
Workload Type Contact Type Workload Description Frequency Average Weekly Learner Workload Hours
Lecture Contact XML in Technical Communications lecture Every Week 3.00 3
Lab Contact XML in Technical Communications lab Every Week 2.00 2
Independent & Directed Learning (Non-contact) Non Contact Independent Study Every Week 9.00 9
Total Hours 14.00
Total Weekly Learner Workload 14.00
Total Weekly Contact Hours 5.00
Workload: Part Time
Workload Type Contact Type Workload Description Frequency Average Weekly Learner Workload Hours
Lecture Contact XML in Technical Communications lecture Every Week 3.00 3
Lab Contact XML in Technicial Communications lab Every Week 2.00 2
Lecturer Supervised Learning (Non-contact) Non Contact Independent Study Every Week 9.00 9
Total Hours 14.00
Total Weekly Learner Workload 14.00
Total Weekly Contact Hours 5.00
 
Module Resources
Recommended Book Resources
  • Jason Swarts. (2020), Writing About Structure In Dita, 1st Edition. Routledge, [ISBN: 9780429059612].
Supplementary Book Resources
  • Laura Bellamy. (2011), DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA, Prentice Hall, Inc., [ISBN: 978-0132480529].
  • Eliot Kimber. (2013), DITA for Practitioners Volume 1, 1. O'Reilly, [ISBN: 9781937434069].
  • Ann Rockley. (2009), Dita 101, The Rockley Group, [ISBN: 978-0-557-07291-0].
This module does not have any article/paper resources
Other Resources
 
Module Delivered in
Programme Code Programme Semester Delivery
CR_KINDD_9 Master of Science in Technical Communication 3 Mandatory
CR_KIDDE_9 Postgraduate Diploma in Science in Technical Communication 3 Mandatory