• The Transactions of The Korean Institute of Electrical Engineers
• /
• v.65 no.1
• /
• pp.171-178
• /
• 2016

In engineering industry, technical documentation refers to any type of documentation that describes handling, functionality and architecture of a technical product. The intended audiences for product technical documentation is the end user, the administrator, service or maintenance technician. Competition and rapid technological evolutions have created pressure to release new and improved products on an increasingly frequent basis. As the technical capabilities of products advance, the technical documentation for those products is becoming longer and complex. The Darwin Information Typing Architecture (DITA) is and XML-based, end-to-end architecture for authoring, producing, and delivering technical documents. DITA is an OASIS standard that allows documentation groups to single-source document for multiple products and users, to automatically publish that documentation in several media formats including PDF and HTML, and to efficiently maintain and update that documentation. This paper study on the various implementation projects for technical documentation using OASIS DITA standard and examines the potential for using DITA as a solution for reconstructing existing technical documentation. Also We offer an incremental adoption approach to effectively implement DITA standard of technical documentation project for domestic firms, while reducing failures.

• Journal of Information Management
• /
• v.2 no.3
• /
• pp.2-4
• /
• 1964

Scientific documentation is one of the three preconditions for scientific research and its technical application in the industrialization process. To solve the documentation problems on an international level, UNESCO promotes abstracting, standardization of terminology and of scientifc publications, automatic information processing and translating. Moreover, UNESCO has helped to establish since 1950, on the request of interested national governments, 12 documentation centers within the framework of United Nations Technical Assistance Programme by providing experts, fellowships and equipment. Some data on these documentation centers and a comparison of their features should be of interest for all those who wish to set up new documentation centers or to improve already existing ones.

• Journal of Internet Computing and Services
• /
• v.20 no.3
• /
• pp.69-75
• /
• 2019

The safety and performance of medical device software is managed through life-cycle processes, which represent the entire process of research and development (R&D). The life-cycle process of medical device software is represented by an international standard called IEC 62304, ISO/IEC 12207. In order to license the product, the manufacturer must have document artifacts that comply with the IEC 62304 standard. However, these standards only describe the content of the activity and do not provide a method or procedure for documentation. Therefore, this paper suggests R&D documentation guidelines that assist medical device software developers to have R&D documents conforming to the standards. For this purpose, this study identifies the requirements related to documentation among the requirements existing in the standard and extracts them in the form of guidelines showing only the core information of the requirements. In addition, through the Web framework implemented based on this research, the developer can evaluate whether the technical documents are written in accordance with the R&D document guidelines. Medical device software manufacturers can efficiently produce high-quality research and development documents through R&D documentation guidelines, and they can have standards-compliantresearch and development documentation required for licensing procedures.

• Journal of Information Technology Services
• /
• v.2 no.1
• /
• pp.135-143
• /
• 2003

As the functional and nonfunctional requirements of defence systems become more complex and precise, concerning about the systematic development of software embedded into the defence systems has become surged up. In order to develop more reliable and correct software, and to extend the life cycle of the developing software, adoption of some engineering technologies such as development process, methodology, CASE tools and documentation is essentially required. This paper introduce an approach to technical information management in embedded software development process, with an instance, airborne ECM system development project. Particularly, we suggest and explain how to guide the software development according to process and methodology, and how to generate technical documents using CASE tool.

• Journal of Korea Society of Industrial Information Systems
• /
• v.15 no.5
• /
• pp.113-118
• /
• 2010

The single-sourcing of content is extremely beneficial because when we are managing several projects with hundreds or thousands of documentation, we don't want to be changing the same content, or substantially similar content in multiple locations. The Darwin Information Typing Architecture (DITA) is an XML-based architecture for authoring, producing, and delivering technical documents. It consists of a set of design principles for creating Information -typed topic modules and for using that content in various ways. In this paper, we examine the approach of using The Darwin Information Typing Architecture for technical documents development to enhance the reuse of existing content components for difference information products.

• Proceedings of The Korean Society of Agricultural and Forest Meteorology Conference
• /
• 2016.09a
• /
• pp.197-200
• /
• 2016

• Journal of Engineering Education Research
• /
• v.15 no.1
• /
• pp.9-17
• /
• 2012

Communication skills, such as writing documents and presenting technical details, are thought to be essential for modern engineers. Engineering students usually have less interest in writing and presentation than their humanities student counterparts and their concerns are different, too. So it is necessary to teach them in a different way which is suited to them. However, teaching such subjects has been a tricky problem for educators in terms of teaching methods. Also, to teach writing and presentation effectively for engineering students, collaboration between the faculties of different disciplines is necessary because each discipline has its own specific domain knowledge and approaches. But many unsolved problems exist with regard to how to deal with the technical and administrative aspects, and so on. This paper introduces one case in the education of technical writing and presentation, which is a collaboration between an engineering faculty and a faculty of literature. The literature faculty conducts basic education and training for writing skills, while the engineering faculty teaches the technical aspects of documentation, as well as presentation skills. The focus is placed on topics such as self-introduction, searching technical literature and materials, describing and explaining things and presentation practice, etc. During the class there is cooperation in each topic domain, while the faculties collaborate in teaching and evaluation.

• Proceedings of the Korean Society for Noise and Vibration Engineering Conference
• /
• 2005.05a
• /
• pp.100-103
• /
• 2005

The aim of the product noise labeling is to harmonize the noise control act relating to noise emission standards, conformity assessment procedure, marking, technical documentation and collection of data concerning the noise emission in the environment of equipment for use outdoors. It will contribute to the smooth functioning of the internal market, while protecting human health and well-being.

• Journal of Ginseng Research
• /
• v.35 no.4
• /
• pp.487-496
• /
• 2011

Good manufacturing practice (GMP)-based quality control is an integral component of the common technical document, a formal documentation process for applying a marketing authorization holder to those countries where ginseng is classified as a medicine. In addition, authentication of the physico-chemical properties of ginsenoside reference materials, and qualitative and quantitative batch analytical data based on validated analytical procedures are prerequisites for certifying GMP. Therefore, the aim of this study was to propose an authentication process for isolated ginsenosides $Rb_1$ and $Rg_1$ as reference materials (RM) and for these compounds to be designated as RMs for ginseng preparations throughout the world. Ginsenoside $Rb_1$ and $Rg_1$ were isolated by Diaion HP-20 adsorption chromatography, silica gel flash chromatography, recrystallization, and preparative HPLC. HPLC fractions corresponding to those two ginsenosides were recrystallized in appropriate solvents for the analysis of physico-chemical properties. Documentation of the isolated ginsenosides was made according to the method proposed by Gaedcke and Steinhoff. The ginsenosides were subjected to analyses of their general characteristics, identification, purity, content quantitation, and mass balance tests. The isolated ginsenosides were proven to be a single compound when analyzed by three different HPLC systems. Also, the water content was found to be 0.940% for $Rb_1$ and 0.485% for $Rg_1$, meaning that the net mass balance for ginsenoside $Rb_1$ and $Rg_1$ were 99.060% and 99.515%, respectively. From these results, we could assess and propose a full spectrum of physicochemical properties for the ginsenosides $Rb_1$ and $Rg_1$ as standard reference materials for GMP-based quality control.

• Journal of Advanced Research in Ocean Engineering
• /
• v.4 no.3
• /
• pp.96-104
• /
• 2018

The importance of data management for the efficient maintenance and operation of offshore structures is becoming increasingly important. This paper has discussed the data schema and business rules that standardize the data exchange between ship design, operation and maintenance. Technical documentation that meets the international standards of ShipDex and S1000D for exchanging the operation and management data in neutral or standard formats has been introduced into the life cycle management of ships. The schema of the data exchange is represented by XML (eXtensible Markup Language) and the lifecycle data is implemented by a structured document. Lifecycle data is represented as data modules defined by XML schema. Given the feasible data generation, an example of a technical document is introduced by a general XML authoring tool.