The software concordance: a new software document management environment

ABSTRACT

In this paper, we describe the efforts of Juniper Networks to implement a Feature Guide documentation manual and discuss the usability merits of this documentation method.

REFERENCES

• 1: Adobe FrameMaker. http://www.adobe.com/products/framemaker/.
• 2: Maurice Amsellem, ChyPro: A Hypermedia Programming Environment for Smalltalk-80, Proceedings of the 9th European Conference on Object-Oriented Programming, p.449-470, August 07-11, 1995
• 3: Kenneth M. Anderson , Richard N. Taylor , E. James Whitehead, Jr., Chimera: hypermedia for heterogeneous software development enviroments, ACM Transactions on Information Systems (TOIS), v.18 n.3, p.211-245, July 2000 [doi>10.1145/352595.352596]
• 4: Greg J. Badros, JavaML: a markup language for Java source code, Proceedings of the 9th international World Wide Web conference on Computer networks : the international journal of computer and telecommunications netowrking, p.159-177, June 2000, Amsterdam, The Netherlands
• 5: Robert A. Ballance , Susan L. Graham , Michael L. Van De Vanter, The Pan language-based editing system, ACM Transactions on Software Engineering and Methodology (TOSEM), v.1 n.1, p.95-127, Jan. 1992 [doi>10.1145/125489.122804]
• 6: James Bigelow , Victor Riley, Manipulating source code in DynamicDesign, Proceeding of the ACM conference on Hypertext, p.397-408, November 1987, Chapel Hill, North Carolina, United States [doi>10.1145/317426.317454]
• 7: John Boyland, Aaron Greenhouse, and William L. Scherlis. The Fluid IR: An internal representation for a software engineering environment. In preparation. For information see http://www.fluid.cs.cmu.edu.
• 8: Jacob L. Cybulski , Karl Reed, A Hypertext Based Software-Engineering Environment, IEEE Software, v.9 n.2, p.62-68, March 1992 [doi>10.1109/52.120603]
• 9: P. Devanbu , Y.-F. Chen , E. Gansner , H. Müller , J. Martin, CHIME: customizable hyperlink insertion and maintenance engine for software engineering environments, Proceedings of the 21st international conference on Software engineering, p.473-482, May 16-22, 1999, Los Angeles, California, United States [doi>10.1145/302405.302679]
• 10: James C. Ferrans , David W. Hurst , Michael A. Sennett , Burton M. Covnot , Wenguang Ji , Peter Kajka , Wei Ouyang, HyperWeb: a framework for hypermedia-based environments, Proceedings of the fifth ACM SIGSOFT symposium on Software development environments, p.1-10, December 09-11, 1992, Tyson's Corner, Virginia, United States
• 11: Pankaj K. Garg , Walt Scacchi, A Hypertext System to Manage Software Life-Cycle Documents, IEEE Software, v.7 n.3, p.90-98, May 1990 [doi>10.1109/52.55233]
• 12: Anja Haake , David Hicks, VerSE: towards hypertext versioning styles, Proceedings of the the seventh ACM conference on Hypertext, p.224-234, March 16-20, 1996, Bethesda, Maryland, United States [doi>10.1145/234828.234850]
• 13: Wendy Hall , Gary Hill , Hugh Davis, The microcosm link service, Proceedings of the fifth ACM conference on Hypertext, p.256-259, November 14-18, 1993, Seattle, Washington, United States [doi>10.1145/168750.168842]
• 14: David L. Hicks , John J. Leggett , Peter J. Nürnberg , John L. Schnase, A hypermedia version control framework, ACM Transactions on Information Systems (TOIS), v.16 n.2, p.127-160, April 1998 [doi>10.1145/279339.279341]
• 15: E Horowitz , R C Williamson, SODOS: a software documentation environment-its use, IEEE Transactions on Software Engineering, v.12 n.11, p.1076-1087, NOV. 1986
• 16: Jorgen Lindskov Knudsen , Boris Magnusson , Mats Lofgren , Ole L. Madsen, Object Oriented Software Development Environments: The Mjolner Approach, Prentice-Hall, Inc., Upper Saddle River, NJ, 1994
• 17: Donald Ervin Knuth, Literate Programming, CSLI Publications, Stanford, CA, 2001
• 18: Alessandra Alaniz Macedo , Maria da Graca Campos Pimentel , Jose Antonio Camacho-Guerrero, An infrastructure for open latent semantic linking, Proceedings of the thirteenth ACM conference on Hypertext and hypermedia, June 11-15, 2002, College Park, Maryland, USA [doi>10.1145/513338.513369]
• 19: Andrian Marcus , Jonathan I. Maletic, Recovering documentation-to-source-code traceability links using latent semantic indexing, Proceedings of the 25th International Conference on Software Engineering, May 03-10, 2003, Portland, Oregon
• 20: Microsoft Office. http://www.microsoft.com/.
• 21: Tom Morse, CVS, Linux Journal, v.1996 n.21es, Jan. 1996
• 22: Ethan V. Munson. The Software Concordance: Bringing hypermedia to the software development process. In SBMIDIA '99 Anais, V Simposio Brasileiro de Sistemas Multimidia e Hipermidia, Goiania, Brazil, June 1999.
• 23: Tien N. Nguyen, Ethan V. Munson, and John T. Boyland. State-based product versioning in the Fluid/SC CM system. In preparation.
• 24: Tien Nguyen , Satish Chandra Gupta , Ethan V. Munson, Versioned Hypermedia can improve software document management, Proceedings of the thirteenth ACM conference on Hypertext and hypermedia, June 11-15, 2002, College Park, Maryland, USA [doi>10.1145/513338.513385]
• 25: Kasper Østerbye, Structural and cognitive problems in providing version control for hypertext, Proceedings of the ACM conference on Hypertext, p.33-42, November 30-December 04, 1992, Milan, Italy [doi>10.1145/168466.168484]
• 26: Kasper Østerbye, Literate Smalltalk Programming Using Hypertext, IEEE Transactions on Software Engineering, v.21 n.2, p.138-145, February 1995 [doi>10.1109/32.345829]
• 27: Kasper Østerbye , Kurt Nørmark, An interaction engine for rich hypertexts, Proceedings of the 1994 ACM European conference on Hypermedia technology, p.167-176, September 19-23, 1994, Edinburgh, Scotland [doi>10.1145/192757.192795]
• 28: Rational Rose. http://www.rational.com/products/rose/index.jsp.
• 29: Steven P. Reiss, Simplifying data integration: the design of the desert software development environment, Proceedings of the 18th international conference on Software engineering, p.398-407, March 25-29, 1996, Berlin, Germany
• 30: James Rumbaugh , Ivar Jacobson , Grady Booch, The Unified Modeling Language reference manual, Addison-Wesley Longman Ltd., Essex, UK, 1998
• 31: M.-A. D. Storey, C. Best, and J. Michaud. SHriMP Views: An interactive and customizable environment for software exploration. In Proceedings of IWPC'2001, May 2001.
• 32: Javadoc tool home page. http://java.sun.com/j2se/javadoc/.
• 33: Tim Teitelbaum , Thomas Reps, The Cornell program synthesizer: a syntax-directed programming environment, Communications of the ACM, v.24 n.9, p.563-573, Sept. 1981 [doi>10.1145/358746.358755]
• 34: Thorn UML editor. http://thorn.sphereuslabs.com/.
• 35: Walter F. Tichy, Design, implementation, and evaluation of a Revision Control System, Proceedings of the 6th international conference on Software engineering, p.58-67, September 13-16, 1982, Tokyo, Japan
• 36: Walter F. Tichy, RCS—a system for version control, Software—Practice & Experience, v.15 n.7, p.637-654, July 1985 [doi>10.1002/spe.4380150703]
• 37: Tim Allen Wagner, Practical algorithms for incremental software development environments, University of California at Berkeley, Berkeley, CA, 1998
• 38: Emmet James Whitehead, Jr. , Richard N. Taylor, An analysis of the hypertext versioning domain, 2000
• 39: Uffe K. Wiil , John J. Leggett, Hyperform: using extensibility to develop dynamic, open, and distributed hypertext systems, Proceedings of the ACM conference on Hypertext, p.251-261, November 30-December 04, 1992, Milan, Italy [doi>10.1145/168466.171510]

INDEX TERMS

Primary Classification:
  D. Software
  D.2 SOFTWARE ENGINEERING
      D.2.6 Programming Environments

Additional Classification:
  H. Information Systems
  H.5 INFORMATION INTERFACES AND PRESENTATION (I.7)
      H.5.4 Hypertext/Hypermedia

General Terms:
Documentation, Management

Keywords:
documentation, hypermedia, software engineering