Live documents with contextual, data-driven information components

ABSTRACT

We introduce the notion of a live document and we describe our concept of live documents with contextual, data driven information components. The dynamic and interactive features of live documents provide a consistent data source for multimedia presentations targeted to various audiences and multiple platforms. Therefore, they contribute to the solution of key challenges in single sourcing and repurposing. We motivate the use of live documents with sample scenarios from the field of systems documentation. We further discuss how live documents can benefit from an interdisciplinary research approach across the fields of technical communications, systems documentation, and software engineering. Finally, cit_af ref_bf(Greenberg, Saul 2001 ref_num129)ref_we describe our experiences with prototype implementations of live documents based on Scalable Vector Graphics (SVG) and Microsoft Office Automation, respectively.

REFERENCES

• 1: Adobe SVG Zone. http://www.adobe.com/svg/
• 2: Patti Anklam, Technical communications as knowledge management: evolution of a profession, Proceedings of the 17th annual international conference on Computer documentation, p.36-44, September 12-14, 1999, New Orleans, Louisiana, United States [doi>10.1145/318372.318390]
• 3: Ball, T.; Eick, S.G., and Mockus, A. 1997.Web-based analysis of large-scale software systems, In ICSE '97 Workshop on Software Engineering (on) the World Wide Webhttp://www.bell-labs.com/user/audris/papers/websoft/
• 4: Brierley, S. 2002. Beyond the buzzword: single sourcing. intercom, Vol. 49, No. 1, pp. 15--17
• 5: Elliot J. Chikofsky , James H. Cross II, Reverse Engineering and Design Recovery: A Taxonomy, IEEE Software, v.7 n.1, p.13-17, January 1990 [doi>10.1109/52.43044 ]
• 6: CNN Article 1997. Microsoft rivals say browser war is really about Windows. http://www.cnn.com/TECH/9710/20/microsoft.impact/
• 7: Norman M. Delisle , Mayer D. Schwartz, Contexts—a partitioning concept for hypertext, ACM Transactions on Information Systems (TOIS), v.5 n.2, p.168-186, April 1987 [doi>10.1145/27636.27639]
• 8: Eick, S.G. et al. 1997. Web-based text visualization. In SOFTSTAT '97 Advances in Statistical Software 6, pp. 3--10, Lucius & Lucius
• 9: Stephen G. Eick , Audris Mockus , Todd L. Graves , Alan F. Karr, A Web laboratory for software data analysis, World Wide Web, v.1 n.2, p.55-60, 1998 [doi>10.1023/A:1019299211575 ]
• 10: Robin Green, Component-based software development: implications for documentation, Proceedings of the 17th annual international conference on Computer documentation, p.159-164, September 12-14, 1999, New Orleans, Louisiana, United States [doi>10.1145/318372.318582]
• 11: Greenberg, S. 2001. Context as a Dynamic Construct. Huma-Computer Interaction, Vol. 16, No. (in press)
• 12: Karl A. Hakkarainen, Unifying documentation teams, Proceedings of the 17th annual international conference on Computer documentation, p.176-184, September 12-14, 1999, New Orleans, Louisiana, United States [doi>10.1145/318372.318591]
• 13: Horn, R.E. 1998. Structured Writing as a Paradigma. In Instructional Development: State of the Art,. Englewood Cliffs, N. J.:, Educational Technology Publications
• 14: Mary Hunter Utt , Robert Mathews, Developing a user information architecture for Rational's ClearCase product family documentation set, Proceedings of the 17th annual international conference on Computer documentation, p.86-92, September 12-14, 1999, New Orleans, Louisiana, United States [doi>10.1145/318372.318563]
• 15: Juhani Iivari, Why are CASE tools not used?, Communications of the ACM, v.39 n.10, p.94-103, Oct. 1996 [doi>10.1145/236156.236183]
• 16: Chris F. Kemerer, How the Learning Curve Affects CASE Tool Adoption, IEEE Software, v.9 n.3, p.23-28, May 1992 [doi>10.1109/52.136161 ]
• 17: Kienle, H. et al. 2002. Leveraging SVG in the Rigi Reverse Engineering Tool. In Proceedings of the SVG Open Developers Conference (on CD Rom and Web), Zurich, Switzerland, July 15-17, 2002
• 18: Macromedia Flash. http://www.openswf.org/
• 19: Maynard, D. and Ananiadou, S. 2000. Terminological Acquaintance: the importance of contextual information in terminology. In Proceedings of the NLP2000 Workshop on Computational Terminology for Medical and Biological Applications, Patras, Greece
• 20: Glenn McAllister, The developer-documenter relationship in Java software development, Proceedings of the 17th annual international conference on Computer documentation, p.144-146, September 12-14, 1999, New Orleans, Louisiana, United States [doi>10.1145/318372.318574]
• 21: Michael Priestley, Dynamically assembled documentation, Proceedings of the 17th annual international conference on Computer documentation, p.53-57, September 12-14, 1999, New Orleans, Louisiana, United States [doi>10.1145/318372.318556]
• 22: Flexible information visualization components for authoring WWW Live Documents. http://citeseer.nj.nec.com/mockus99flexible.html
• 23: Audris Mockus , Stacie Hibino , Todd Graves, A Web-based approach to interactive visualization in context, Proceedings of the working conference on Advanced visual interfaces, p.181-188, May 2000, Palermo, Italy [doi>10.1145/345513.345308]
• 24: H. A. Müller , K. Klashinsky, Rigi-A system for programming-in-the-large, Proceedings of the 10th international conference on Software engineering, p.80-86, April 11-15, 1988, Singapore
• 25: Thomas A. Phelps , Robert Wilensky, Multivalent documents, Communications of the ACM, v.43 n.6, p.82-90, June 2000 [doi>10.1145/336460.336480]
• 26: Allison L. Powell , James C. French , John C. Knight, A systematic approach to creating and maintaining software documentation, Proceedings of the 1996 ACM symposium on Applied Computing, p.201-208, February 17-19, 1996, Philadelphia, Pennsylvania, United States [doi>10.1145/331119.331176]
• 27: Rick Sobiesiak, Towards a new generation of authoring tools, Proceedings of the 13th annual international conference on Systems documentation: emerging from chaos: solutions for the growing complexity of our jobs, p.157-161, September 30-October 03, 1995, Savannah, Georgia, United States [doi>10.1145/223984.224013]
• 28: Carl Stieren, Add one egg, a cup of milk, and stir: single source documentation for today, Proceedings of the 15th annual international conference on Computer documentation, p.255-262, October 19-22, 1997, Salt Lake City, Utah, United States [doi>10.1145/263367.263400]
• 29: SUN Javadoc. http://java.sun.com/j2se/javadoc/
• 30: SUN and SVG. http://www.sun.com/software/xml/developers/svg/
• 31: Susan Korgen, Object-oriented, single-source, on-line documents that update themselves, Proceedings of the 14th annual international conference on Systems documentation: Marshaling new technological forces: building a corporate, academic, and user-oriented triangle, p.229-237, October 19-22, 1996, Research Triangle Park, North Carolina, United States [doi>10.1145/238215.238301]
• 32: Marcelo Tallis , Neil M. Goldman , Robert M. Balzer, The Briefing Associate: Easing Authors into the Semantic Web, IEEE Intelligent Systems, v.17 n.1, p.26-32, January 2002 [doi>10.1109/5254.988445 ]
• 33: Scott R. Tilley, Management decision support through reverse engineering technology, Proceedings of the 1992 conference of the Centre for Advanced Studies on Collaborative research, November 09-12, 1992, Toronto, Ontario, Canada
• 34: Scott R. Tilley, Documenting-in-the-large vs. documenting-in-the-small, Proceedings of the 1993 conference of the Centre for Advanced Studies on Collaborative research: distributed computing, October 24-28, 1993, Toronto, Ontario, Canada
• 35: W3C Scalable Vector Graphics (SVG). http://www.w3.org/Graphics/SVG/Overview.htm8
• 36: William W. Wadge , m. c. schraefel, A Complementary Approach for Adaptive and Adaptable Hypermedia: Intensional Hypertext, Revised Papers from the nternational Workshops OHS-7, SC-3, and AH-3 on Hypermedia: Openness, Structural Awareness, and Adaptivity, p.327-334, August 14-18, 2001
• 37: Andrew Walenstein, Theory-based Analysis of Cognitive Support in Software Comprehension Tools, Proceedings of the 10th International Workshop on Program Comprehension, p.75, June 27-29, 2002
• 38: Wong, K. 1998.The Rigi Manual, http://ftp.rigi.csc.uvic.ca/pub/rigi/doc/rigi-5.4.4-manual.pdf
• 39: Kenny Wong , Halisi A. Muller , Frank Ruskey, The reverse engineering notebook, 2000

INDEX TERMS

Primary Classification:
  I. Computing Methodologies
  I.7 DOCUMENT AND TEXT PROCESSING
      I.7.2 Document Preparation
          Subjects: Desktop publishing

Additional Classification:
  D. Software
  D.2 SOFTWARE ENGINEERING
      D.2.7 Distribution, Maintenance, and Enhancement
          Subjects: Documentation; Restructuring, reverse engineering, and reengineering

  H. Information Systems
  H.4 INFORMATION SYSTEMS APPLICATIONS
      H.4.1 Office Automation
          Subjects: Word processing; Spreadsheets; Workflow management

  I. Computing Methodologies
  I.7 DOCUMENT AND TEXT PROCESSING
      I.7.2 Document Preparation
          Subjects: Hypertext/hypermedia; Markup languages; Multi/mixed media; Scripting languages

General Terms:
Documentation

Keywords:
Microsoft Office, live documents, repurposing, reverse engineering, scalable vector graphics, single sourcing, software engineering, systems documentation