ManPro: Framework for the Generation and Assessment of Documentation for Nuclear Facilities

  • Cristina Olaverri-Monreal
  • Carsten Dlugosch
  • Klaus Bengler
Part of the Advances in Intelligent Systems and Computing book series (AISC, volume 206)


Nuclear plant operators must act in accordance with a number of requirements which are specified in the technical documentation that describes handling, functionality and architecture of the systems. Due to these many specifications to be considered, it is crucial to create technical documentation in order to improve the operation efficiency of such facilities and prevent human errors whenever possible. In this work, we propose a procedure (ManPro) for the computer-based creation of instruction manuals for the operation of technical systems. The “ManPro” approach is semiautomatic, which underlines its reproducibility and efficiency. Feasibility of the approach and its effects on usability are assessed and outlined.


Nuclear facilities Technical documentation Mark up languages XSLT XML UML 


Unable to display preview. Download preview PDF.

Unable to display preview. Download preview PDF.


  1. 1.
    Pyzdek, T., Keller, P.: Quality engineering handbook, vol. 60. CRC (2003)Google Scholar
  2. 2.
    ISO: 01.110: Technical product documentation, international organization standardization (July 2012),
  3. 3.
    ISO/IEC: Isoiec 26514-2008 systems and software engineering. Requirements for designers and developers of user documentation (July 2012),
  4. 4.
    Carver, D.: Designing the user interface, strategies for effective human-computer interaction. Journal of the American Society for Information Science 39(1), 22–22 (1988)CrossRefGoogle Scholar
  5. 5.
    Parnas, D., Asmis, G., Madey, J.: Assessment of safety-critical software in nuclear power plants. Nuclear Safety 32(2), 189–198 (1991)Google Scholar
  6. 6.
    Heymann, M., Degani, A.: Formal analysis and automatic generation of user interfaces: Approach, methodology, and an algorithm. Human Factors: The Journal of the Human Factors and Ergonomics Society 49(2), 311–330 (2007)CrossRefGoogle Scholar
  7. 7.
    Jacobson, I., Booch, G., Rumbaugh, J.: The Unified Software Development Process. Addison-Wesley (1999)Google Scholar
  8. 8.
    Pressman, R.S.: Software Engineering – A practitioner’s approach, 6th edn. Mc Graw Hill (2005)Google Scholar
  9. 9.
    da Cruz, A.M.R., Faria, J.P.: Automatic Generation of User Interface Models and Prototypes from Domain and Use Case ModelsGoogle Scholar
  10. 10.
    Silva, A.R., Saraiva, J., Silva, R., Martins, C.: XIS - UML profile for extreme modeling interactive systems. In: Proceedings of the 4th International Workshop on Model-based Methodologies for Pervasive and Embedded Software (MOMPES 2007). IEEE (March 2007)Google Scholar
  11. 11.
    Pastor, O., Molina, J.: Model-driven Architecture in Practice – A software production environment based on Conceptual Modeling. Springer (2007)Google Scholar
  12. 12.
    Molina, P.J., Hernández, J.: Just-UI: Using patterns as concepts for IU specification and code generation. In: Perspectives on HCI Patterns: Concepts and Tools (CHI 2003 Workshop) (2003)Google Scholar
  13. 13.
    Jia, X., Steele, A., Liu, H., Qin, L., Jones, C.: Using ZOOM approach to support MDD. In: Proceedings of the 2005 International Conference on Software Engineering Research and Practice (SERP 2005), Las Vegas, USA (2005)Google Scholar
  14. 14.
    Courtois, P.J., Parnas, D.L.: Documentation for safety critical software. Book Documentation for safety critical software, pp. 315–323. IEEE, City (1993)Google Scholar
  15. 15.
    Johnson, W., et al.: Dynamic (re) generation of software documentation. In: Proceedings of the Fourth Systems Reengineering Technology Workshop (1994)Google Scholar
  16. 16.
    Riva, C., Yang, Y.: Generation of architectural documentation using xml. In: Proceedings of Ninth Working Conference on Reverse Engineering, pp. 161–169. IEEE (2002)Google Scholar
  17. 17.
    Olaverri-Monreal, C., Bengler, K., Breisinger, M., Draxler, C.: Markup languages and menu structure transformation during the internationalisation process of driver information systems. Localisation Focus, 4 (2010)Google Scholar
  18. 18.
    Kazman, R., O’Brien, L., Verhoef, C.: Architecture reconstruction guidelines (2001)Google Scholar
  19. 19.
    Nentwich, C., Emmerich, W., Finkelstein, A., Zisman, A.: Box: Browsing objects in xml. Software-Practice and Experience 30(15), 1661–1676 (2000)MATHCrossRefGoogle Scholar
  20. 20.
    Zöllner, R., Patakui, K., Rosenthal, K.P.: Generation of the user documentation by means of software’s specification in uml. In: Proceedings of the International Symposium Facteurs Humains et Conception des Systèmes de Travail. Optimiser les Performances de lEnterprise. Nizza. Comit AISS Recherche (2006)Google Scholar
  21. 21.
    Yu, A., Steele, R.: An overview of research on reverse engineering xml schemas into uml diagrams. In: Third International Conference on Information Technology and Applications, ICITA 2005, vol. 2, pp. 772–777. IEEE (2005)Google Scholar
  22. 22.
    Jensen, M., Møller, T., Pedersen, T.: Converting xml dtds to uml diagrams for conceptual data integration. Data & Knowledge Engineering 44(3), 323–346 (2003)CrossRefGoogle Scholar
  23. 23.
    Zanden, B., Myers, B.: Automatic, look-and-feel independent dialog creation for graphical user interfaces. In: Proceedings of the SIGCHI Conference on Human Factors in Computing Systems: Empowering People, pp. 27–34. ACM (1990)Google Scholar
  24. 24.
    Koo, S., Son, H., Seong, P.: A method of formal requirement analysis for npp i&c systems based on uml modeling with software cost reduction. Journal of Systems and Software 67(3), 213–224 (2003)CrossRefGoogle Scholar
  25. 25.
    Chase, N.: Using jdbc to extract data into xml (November 2012),
  26. 26.
    XMLDOM: Xml dom the document object, 57–66 (November 2012),
  27. 27.
    Inaba, K., Parsons, S.O., Smillie, R.J.: Guidelines for developing instructions. CRC (2004)Google Scholar

Copyright information

© Springer-Verlag Berlin Heidelberg 2013

Authors and Affiliations

  • Cristina Olaverri-Monreal
    • 1
  • Carsten Dlugosch
    • 1
  • Klaus Bengler
    • 1
  1. 1.Institute of Ergonomics, Department of Mechanical EngineeringTechnische Universität MünchenGarchingGermany

Personalised recommendations