Exploiting patterns and templates for technical documentation

被引:1
|
作者
Caponi, Alessandro [1 ]
Di Iorio, Angelo [1 ]
Vitali, Fabio [1 ]
Alberti, Paolo [2 ]
Scata, Marcello [2 ]
机构
[1] Univ Bologna, Dept Comp Sci, Bologna, Italy
[2] Alstom, Bologna, Italy
关键词
Collaborative editing; !text type='HTML']HTML[!/text; Technical documentation; Templating;
D O I
10.1145/3209280.3209537
中图分类号
TP [自动化技术、计算机技术];
学科分类号
0812 ;
摘要
There are several domains in which the documents are made of reusable pieces. Template languages have been widely studied by the document engineering community to deal with common structures and textual fragments. Though, templating mechanisms are often hidden in mainstream word-precessors and even unknown by common users. This paper presents a pattern-based language for templates, serialized in HTML and exploited in a user-friendly WYSIWYG editor for writing technical documentation. We discuss the deployment of the editor by an engineering company in the railway domain, as well as some generalized lessons learned about templates.
引用
收藏
页数:9
相关论文
共 50 条
  • [1] TECHNICAL DOCUMENTATION
    SEARCH, P
    NCGA 89 CONFERENCE PROCEEDINGS, VOLS 1-3, 1989, : C182 - C190
  • [2] EXPORT OF TECHNICAL DOCUMENTATION
    GORSKI, M
    PRZEMYSL CHEMICZNY, 1992, 71 (03): : 111 - 113
  • [3] TECHNICAL DOCUMENTATION IN THE NETHERLANDS
    DIELS, JC
    SPECIAL LIBRARIES, 1959, 50 (10) : 488 - 491
  • [4] The technical analysis on translation templates
    Liu, Y
    Zong, CQ
    2004 IEEE INTERNATIONAL CONFERENCE ON SYSTEMS, MAN & CYBERNETICS, VOLS 1-7, 2004, : 4799 - 4803
  • [5] UTILIZATION OF DOCUMENTATION TEMPLATES TO GUIDE APPROPRIATE PRACTICE
    Bartnicki, Rebecca
    Best, Carolyn
    Karius, Diana
    Rodgers, Georgina
    ONCOLOGY NURSING FORUM, 2023, 50 (02)
  • [6] TEMPLATES, PATTERNS IN LIGHT
    HELLER, B
    THEATRE CRAFTS, 1990, 24 (01): : 24 - 28
  • [7] TECHNICAL DOCUMENTATION IN TRAFFIC TECHNOLOGY
    Curepic, Danko
    Tos, Zdravko
    PROMET-TRAFFIC & TRANSPORTATION, 2009, 21 (05): : 359 - 365
  • [8] TECHNICAL DOCUMENTATION COMES OF AGE
    MILLER, DM
    INFORMATION MANAGEMENT, 1985, 19 (03): : 13 - &
  • [9] Automatic generation of technical documentation
    Andersen, Asbjørn, 1600, Elsevier Ltd (03):
  • [10] MULTILINGUALISM IN SCIENTIFIC AND TECHNICAL DOCUMENTATION
    OLIER, JHD
    INTERNATIONAL FORUM ON INFORMATION AND DOCUMENTATION, 1977, 2 (04): : 20 - 24