The Transactions of The Korean Institute of Electrical Engineers (전기학회논문지)

The Korean Institute of Electrical Engineers (대한전기학회)
권호 표지
DOI QR코드

DOI QR Code

Adopting DITA Standard for Developing Technical Documentation Efficiently

효율적인 기술문서 개발을 위한 DITA 표준 적용

  • Koo, Heung-Seo (Dept. of Computer and Information Engineering., Cheong-Ju Univ.)
  • Received : 2015.12.05
  • Accepted : 2015.12.14
  • Published : 2016.01.01
Download PDF
⟨ Previous Next ⟩

Abstract

In engineering industry, technical documentation refers to any type of documentation that describes handling, functionality and architecture of a technical product. The intended audiences for product technical documentation is the end user, the administrator, service or maintenance technician. Competition and rapid technological evolutions have created pressure to release new and improved products on an increasingly frequent basis. As the technical capabilities of products advance, the technical documentation for those products is becoming longer and complex. The Darwin Information Typing Architecture (DITA) is and XML-based, end-to-end architecture for authoring, producing, and delivering technical documents. DITA is an OASIS standard that allows documentation groups to single-source document for multiple products and users, to automatically publish that documentation in several media formats including PDF and HTML, and to efficiently maintain and update that documentation. This paper study on the various implementation projects for technical documentation using OASIS DITA standard and examines the potential for using DITA as a solution for reconstructing existing technical documentation. Also We offer an incremental adoption approach to effectively implement DITA standard of technical documentation project for domestic firms, while reducing failures.

Keywords

References

  1. Howard Schwartz, "A Paradigm Shift for Technical Documentation", KMworld, pp.1-4. April 2011.
  2. P.G. Bartlett, Finding an Easy Path to DITA, White Paper, Quark Software Inc., 2011.
  3. Deborah Pickett, "An Introduction to DITA", Open Source Developers' Conference 2005, Australia, pp.53-61, Dec.1-3 2005.
  4. Kristen James Eberlein (Sep. 8, 2015). "Progress of DITA1.3", dita.xml.org. [Online]. Available: http://dita.xml.org
  5. Don Day, Michael Priestley, Dave Schell, Introduction to the Darwin Information Typing Architecture, Developer Works, IBM, Sep. 28, 2005.
  6. Tony Self, Separation of Content and Form, White Paper, Adobe, 2013.
  7. Joe Lowmiller (Oct. 11, 2013). "Technical Writing Examples in Three Major Categories", udemy. [Online]. Available: https://blog.udemy.com/technical-writing-examples/
  8. Today's Technical Publication Challenges, White Paper, Quark Software Inc., April 28 2011.
  9. "About the OASIS DITA Technical Committee and Subcommittees", dita.xml.org. [Online]. Available: http://dita.xml.org/book/export/html/1440 (downloaded Oct. 5, 2015)
  10. Michael Priestley, Amber Swope, DITA Maturity Model, White Paper, JUST SYSTEMS, 2008.
  11. Keith Schengiil-Roberts (Feb. 7, 2012). "So Who's Using DITA?", DITAWriter. [Online]. Available: http://www.ditawriter.com/so-whos-using-dita/
  12. Keith Schengiil-Roberts, "Who Is Using DITA?: DITA Usage By Industry Sector (update)", Information Management News, CIDM, March 2012.
  13. Keith Schengiil-Roberts (Jan. 10, 2013). "So Who's Using DITA? (update)", DITAWriter. [Online] Available: http://www.ditawriter.com/so-whos-using-dita-january-2013-update/
  14. Keith Schengili-Roberts, "DITA Diversity in Technical Documentation", CIDM's BEST PRACTIC-ES, CIDM, pp. 139-143, Dec. 2014.
  15. Keith Schengiil-Roberts (Sep. 1, 2015). "Companies Using DITA", DITAWriter. [Online] Available: http://www.ditawriter.com/companies-using-dita/
  16. Rearchitecting a Small Software Company's Information, SDI Solutions, White Paper. 2009.
  17. Petra von Thienen, "Best Practice: Using DITA with DITAworks in Software Documentation Projects", Best Practice Newsletter, CIDM, vol.16, no.2, pp.25-29, April 2014.
  18. Marie Sakai, Taku Okuno, "Building DITA-based CMS as Integrated Documentation Environment", SCIS-ISIS 2012, Kobe, Japan, IEEE, pp.1816-1820, Nov.20-24, 2012.
  19. Joaquim Baptista, "20 Years of Technical Writing at Altitude Software", ISDOC'14 Proc. of International Conference on Information Systems and Design of Communication, ACM, pp.166-172, May 16-17, 2014.
  20. Ekaterina Stepalina, "SaaS Support in Software Documentation Systems", CEE-SECR 2010, Mowcow, Russia, IEEE, pp.192-197, Oct. 13-14, 2010.
  21. France Brail, "DITA-The mechanics of a single sourcing project", Proc. of XML 2004 Conference, Montreal Canada, pp.104-111, Aug. 2-6, 2004.
  22. Twelve DITA Implementations and the Lessons Learned, White Paper, Data Conversion Laboratory Inc., May 12, 2011.