Skip to main content
SpringerLink
Log in

DocLine: A method for software product lines documentation development

  • Published:
Programming and Computer Software Aims and scope Submit manuscript

Abstract

The DocLine method designed for developing documentation for software product lines is presented. The method makes it possible to reuse document fragments with adaptation to a particular usage context. The method provides the Documentation Reuse Language (DRL) that has a graphical part (for designing the structure of documentation packages) and a text part (for implementing the documentation). It also describes a process for developing documentation and a toolset architecture based on the DSM approach and Eclipse GMF technology.

This is a preview of subscription content, log in via an institution to check access.

Access this article

Log in via an institution

Price excludes VAT (USA)
Tax calculation will be finalised during checkout.

Instant access to the full article PDF.

Institutional subscriptions

Similar content being viewed by others

References

  1. Margues, M., Single-sourcing with FrameMaker, TECHWR-L Magazine Online, http://www.techwr-1.com/techwhirl/magazine/technical/singlsourcing.html.

  2. Walsh, N. and Muellner, L., DocBook: The Definitive Guide, O’Reilly, 1999.

  3. Day, D., Priestley, M., and Schell, D.A., Introduction to the Darwin Information Typing Architecture—Toward Portable Technical Information, http://www-106.ibm.com/developerworks/xml/library/x-dita1/.

  4. Clements, P. and Northrop, L., Software Product Lines: Practices and Patterns, Boston, Mass.: Addison-Wesley, 2002.

    Google Scholar 

  5. Bassett, P., Framing Software Reuse—Lessons from Real World, Prentice Hall, 1996.

  6. Kang, K., Cohen, S., Hess, J., Novak, J., et al., Feature-Oriented Domain Analysis (FODA): Feasibility Study, Teclin, Report of Software Engineering Institute, Carnegie Mellon University, Pittsburg, 1990, CMU/SEI-90-TR-21.

  7. Romanovsky, K.Yu., A Method for Developing Documentation for Software Product Lines, System Programming, Terekhov, A.N. and Bulychev, D.Yu., Eds., issue 2, St. Petersburg: Izd. St. Perersburg. Gos. Univ., 2007, pp. 191–218.

    Google Scholar 

  8. Romanovsky, K.Yu. and Koznov, D.V., DRL: A Language for Designing and Developing Documentation for Software Product Lines, Vestn. S. Peterb. Univ., Ser. 10.2007, issue 4, pp. 110–122.

  9. Koznov, D.V., Peregudov, A.F., Romanovsky, K.Yu., Kashin, A., and Timofeev, A., Experience in Using UML for Developing Technical Documentation, Terekhov, A.N. and Bulychev, D.Yu., Eds., issue 1, St. Petersburg: Izd. St. Perersburg. Gos. Univ., 2005, pp. 18–36.

    Google Scholar 

  10. Czarnecki, K. and Eisenecker, U., Generative Programming: Methods, Tools, and Applications, Reading, Mass.: Addison-Wesley, 2000.

    Google Scholar 

  11. Greenfield, J., Short, K., Cook, S., and Kent, S., Software Factories: Assembling Applications with Patterns, Models, Frameworks, and Tools, Indianapolis: Wiley, 2004.

    Google Scholar 

  12. Parnas, D. On the Design and Development of Program Families, IEEE Trans. Software Eng., 1976, March, pp. 1–9.

  13. Software Engineering Institute (SEI), http://www.sei.cmu.edu/plp.

  14. European Software Institute (ESI), http://www.esi.es.

  15. Krueger, C., Eliminating the Adoption Barrier, IEEE Software, 2002, July–August, pp. 29–31.

  16. Krueger, C., New Methods in Software Product Line Practice, Commun. ACM, 2006, vol. 49, no. 12, pp. 37–40.

    Article  Google Scholar 

  17. Clements, P., Being Proactive Pays Off, IEEE Software, 2002, July–August, pp. 28–31.

  18. Rockley, A., Kostur, P., and Manning, S., Managing Enterprise Content: A Unified Content Strategy, New Riders, 2002.

  19. DocBook Project, http://sourceforge.net/projects/doc-book.

  20. Adobe Frame Maker, http://www.adobe.com/products/framemaker/.

  21. Adobe RoboHelp, http://www.adobe.com/products/robohelp/.

  22. Jarzabek, S., Bassett, P., Zhang, H., and Zhang, W., XVCL: XML-based Variant Configuration Language, Proc. of the 25th Int. Conf. on Software Engineering, 2003, pp. 810–811.

  23. Yang, J. and Jarzabek, S., Applying a Generative Technique for Enhanced Reuse on J2EE Platform, 4th Int. Conf. on Generative Programming and Component Enegineering, GPCE’05, Tallinn, 2005, pp. 237–255.

  24. Jarzabek, S. and Zhang, H., XML-based Method and Tool for Handling Variant Requirements in Domain Models, Proc. of the 5th Int. Symp. on Requirements Engineering, RE’01 Toronto, 2001, IEEE Press, 2001, pp. 166–173.

  25. Netron, http://www.netron.com/.

  26. Feature Modeling Plug-in, https://sourceforge.net/projects/fmp/.

  27. XFeature, http://www.pnp-software.com/XFeature/.

  28. Preface, J. Visual Lang. Comput., 2004, vol. 15, pp. 207–209.

  29. ITU-T Recommendation Z.100: Specification and Description Language (SDL), 1999.

  30. Assmann, U., Automatic Roundtrip Engineering, Workshop on Software Composition, Warsaw, 2003, Electronic Notes Comput. Sci., 2003, vol. 82, no. 5, pp. 1–9.

    Google Scholar 

  31. PhiloSoft Forum, http://forum.philo-soft.ru/cgi-bin/forum/ikonboard.cgi.

  32. Albing, B., Combining Human-Authored and Machine-Generated Software Product Documentation, Proc. of the Professional Communication Conference, 2003, IEEE Int. Volume, 2003, pp. 6–11.

  33. List of companies using DITA, http://dita.xml.org/deployments.

  34. List of Companies Using DocBook, http://wiki.docbook.org/topic/WhoUsesDocBook.

Download references

Author information

Authors and Affiliations

  1. Department of Mathematics and Mechanics, St. Petersburg State University, Universitetskii pr. 28, Staryi Petergof, St. Petersburg, 198504, Russia

    D. V. Koznov & K. Yu. Romanovsky

Authors
  1. D. V. Koznov
    View author publications

    You can also search for this author in PubMed Google Scholar

  2. K. Yu. Romanovsky
    View author publications

    You can also search for this author in PubMed Google Scholar

Corresponding author

Correspondence to D. V. Koznov.

Additional information

Original Russian Text © D.V. Koznov, K.Yu. Romanovsky, 2008, published in Programmirovanie, 2008, Vol. 34, No. 4.

Rights and permissions

Reprints and permissions

About this article

Cite this article

Koznov, D.V., Romanovsky, K.Y. DocLine: A method for software product lines documentation development. Program Comput Soft 34, 216–224 (2008). https://doi.org/10.1134/S0361768808040051

Download citation

  • Received:

  • Published:

  • Issue Date:

  • DOI: https://doi.org/10.1134/S0361768808040051

Keywords

Search

Navigation