• Title/Summary/Keyword: User documentation

Search Result 41, Processing Time 0.022 seconds

Adopting DITA Standard for Developing Technical Documentation Efficiently (효율적인 기술문서 개발을 위한 DITA 표준 적용)

  • Koo, Heung-Seo
    • 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.

BIM Application Process for Facility Condition Assessment Documentation Work

  • Yoo, Seung Eun;Yu, Jung Ho
    • International conference on construction engineering and project management
    • /
    • 2015.10a
    • /
    • pp.268-270
    • /
    • 2015
  • Overseas countries' government and facility management industries make efforts to ensure precise and fluent data from building information modeling (BIM). In facility management, a large amount of data and information are necessary to continue the process activities. Facility condition assessment, which is performed to make budget plan for the maintenance and operation requires the related facilities' documentation and information. However, it depends on the owner and the user of the facility to provide accurate and complete information to consultant. The problems as follows: (1) owner and user should provide documents and information, and (2) the consultant cannot verify the provided information. To solve these problems, we suggest a methodology to produce the information for FCA through BIM. First, all of the essential documentation and assessment elements are listed. Next, the documents and elements are separated out, whether they are able to be extracted from BIM or not. Then, the list indicates only the data that is linked with BIM. The suggestion is expected to provide the required information through the connection to BIM with accuracy and completeness and to present another BIM application use for facility management.

  • PDF

A study on the evaluation of package software documentation to improve software quality (패키지 문서 평가를 통한 소프트웨어 품질 확립에 관한 연구)

  • Kim, Hyo-Yeong;Kim, Han-Han;Han, Hyeok-Su;Kim, Sun-Yong;Sin, Seok-Gyu;Jeong, Yeong-Eun
    • The KIPS Transactions:PartD
    • /
    • v.9D no.4
    • /
    • pp.629-638
    • /
    • 2002
  • As the application area of software grows bigger and the importance of software quality increases, software quality evaluation method is also getting a lot of attention. To evaluate the software quality properly, we need an objective and concrete evaluation mechanism. In general, practitioners customize the international standards to their own needs for this purpose. Package software documents plat an important role in software quality evaluation because it provides the information that helps customers use the software effectively and conveniently. h great deal of efforts has been made in terms of international standards for documentation and documentation process. However, those international standards are too abstract to be applied directly to domestic software packages. In this paper, we developed a guidelines and checklists for writing and evaluating package software documents. Our research basically followed ISO 12119, ISO 9127 and some related research results. Also we proved the effectiveness of this research through actual tests with package softwares.

A Research of Data Gathering Middleware and User Friendly Display for vessel PMS(Planned Maintenance System) (선박 PMS를 위한 데이터 수집 미들웨어와 사용자 편의적 디스플레이연구)

  • Lee, Seojeong
    • Journal of Information Technology Services
    • /
    • v.12 no.2
    • /
    • pp.335-348
    • /
    • 2013
  • Vessel PMS (Planned Maintenance System) is a paper and/or software based system to monitor vessel engine equipment including main propulsion, steering, auxiliary machinery and cargo handling information. This is one of mandatory survey for vessel introduced by IMO (International Maritime Organization). The planned maintenance as well as documentation must be performed according to a system to be approved by classification agencies. Recently, vessel owners have preferred software based systems to collect and preserve accurate data. However, not ship specific and not taking into account the user are said by end users as operational difficulties. To relieve these concerns, this research analyzes vessel PMS data, suggests a middleware to support automatic collection and design consideration of user interface.

A Theoretical Study on the Measurement of User Information Satisfaction on the Information System (정보시스템 이용자의 정보만족도 측정에 관한 이론적 고찰)

  • Ahn, Sang-Keun;Choi, Min-Ho;Kim, Sung-Soo
    • Journal of Agricultural Extension & Community Development
    • /
    • v.4 no.1
    • /
    • pp.201-209
    • /
    • 1997
  • The objective of this study were 1) to review concepts of user information satisfaction (UIS), 2) to analyze tools for measuring user information satisfaction, 3) to identify factors affecting information satisfaction. The study was carried out by the analysis of literatures related to information system. The construct of UIS has been operationalized in many different ways. Several studies employed single-item rating scales; such scales have been criticized as unreliable. Single-item scales also provide little information as to what the user finds dissatisfying(satisfying) and are thus of limited utility outside a research setting. Multiple-item UIS measures have become increasingly common. Generally, they are of two types. The first focuses on the information system product. With such diverse names as "system acceptance", "output quality", and "appreciation", these scales focus on the content of the information system and the manner in which the information is presented. The second type of multiple-item scale includes the organizational support for developing and maintaining the system as well as the system product itself. This type of instrument contains items concerned with training, documentation, development procedures, systems maintenance, etc., as well as items related to system content. Thus it provides an indicator of the overall quality of information services provided by an information service function. Generally, UIS measures have not been carefully validated. Recently, however, several rigorous attempts have been made to develop valid and reliable UIS measure.

  • PDF

A Comparative Study of Evaluation Factors on Information Systems between the User and the Developer (정보시스템 개발자와 이용자 간의 평가요소에 대한 비교 연구)

  • 조현양
    • Journal of the Korean Society for information Management
    • /
    • v.13 no.1
    • /
    • pp.143-172
    • /
    • 1996
  • The purpose of the study is to set up factors for evaluating information systems which can meet both users' and developers' needs. These factors can be used as a framework in developing successful information systems. To achieve this purpose factors are selected first from the literature review by the previous studies. Then two different questionnaires based on selected factors were made up and distributed to two separate groups; users and developers. It appeared that there are significant differences on ranking and weighting for evaluation factors of information systems between the user and the developer. 185 factors for evaluating information systems are divided into 9 criteria based on their roles. There are significant differences on ranking under 6 out of 9 evaluation criteria between two groups. These are 'effectiveness', 'usability', 'user friendliness', 'documentation', 'output', 'maintenance'. However, there are no significant differences on factors in 'performance', 'developer', and 'user satisfaction' criteria. As a result of the study 185 factors for evaluating information systems were presented with rank.

  • PDF

Study of a prevention model against institutional documentation forgery using blockchain technology (블록체인 기술을 이용한 학교문서위조 예방모델의 연구)

  • Kim, Kee-Hong;Kim, Dong-Chul
    • Journal of Arbitration Studies
    • /
    • v.28 no.2
    • /
    • pp.165-178
    • /
    • 2018
  • Exchanging information with a person without credentials over the Internet does not pose any problems. A decentralized system based on blockchain technology enables the user to exchange new value(currency) with other uncredited users. The blockchain technology creates a new paradigm in which the distribution system can be founded on trust. Various applied distribution systems are being developed based on this paradigm. This study analyzed the problems between an institute's grading system and the central administration system. The limitations of an institute's current central management system were presented through actual cases. To improve the problem, a decentralized system based on block chain technology was presented in order to overcome the fundamental limitations by utilizing blockchain technology, peer-to-peer network, and the distribution system. In the central system, a malicious moderator could create a malicious edit that becomes the cause of a dispute, but in a decentralized system, a problem cannot be created even if there were to be a malicious moderator. However, it is difficult for a single college institute to create a distribution system in order to actualize an effective system. Comparatively, it would be possible to create a decentralized system in which all educational institutes in Korea (elementary schools, middle schools, high schools, colleges) took part in. The application of a decentralized system would improve the public transparency and reliability of educational institutes.

Use Case Development for Next Generation Electronic Nursing Record Systems Utilizing Clinical Workflow Analysis and a Delphi Survey (차세대 전자간호기록 시스템 유스케이스 개발: 업무흐름 분석과 전문가 델파이 기법 적용)

  • Cho, Insook;Choi, Woan Heui;Hyun, Misuk;Park, Yonok;Lee, Yoona;Lee, Sooyoun;Hwang, Okhee
    • Journal of Korean Clinical Nursing Research
    • /
    • v.21 no.3
    • /
    • pp.377-388
    • /
    • 2015
  • Purpose: To identify user requirements for electronic nursing record (ENR) systems so as to ensure system usability. Methods: A mixed methods approach were applied in three steps : (i) task and workflow analysis with literature review of nursing documentation, (ii) literature reviews of system usability, and (iii) Use Case idenfication and consensus-based validation. We analyzed the nursing activity logs collected from a time-motion investigation of six hospitals. The Use Cases were validated by eight clinical experts from different hospitals and two experts from academia in a sequential Delphi survey. Consensus was achieved for the significance score and agreement among the panel. Results: Eight task groups and patterns of task flow were observed, which were translated into nine Use Cases. The specification of Use Cases was derived from principles, guidelines, and recommendations on nursing documentation and electronic health record systems, which was organized into three requirements of each Use Case: functionality, information, and design characteristics. Each Use Case achieved an agreement of 50~70%, and significance scores of 4 or 5 on a 5-point Likert scale. Conclusion: The nine Use Case identified were considered to be important and adequate in terms of both clinical and informatics contexts.

An Implementation of the Multimedia Dynamic Authoring System based on Causality Model (인과성 모델에 기반 한 멀티미디어 동적 저작시스템 구현)

  • Shin Hyun-san
    • Journal of Internet Computing and Services
    • /
    • v.5 no.6
    • /
    • pp.67-77
    • /
    • 2004
  • In this paper, we implement the multimedia dynamic authoring system based on causality model. we define two specifications which support user to specify intuitively and naturally what he/she wants, The temporal specification describes causal-based temporal relationships between presentation objects, and the spatial specification describes relative layout structure among objects on the screen. Using the specifications, the system processes for multimedia documentation are one-dimensional string list, relational trees, such as temporal. spatial, and annotated composition tree generation phases.

  • PDF

A Method of Quantification of VDT Display Design and Comparative Analysis of User Performance (VDT 화면설계특성의 정량화 및 사용자 수행도의 비교분석)

  • 황우상;부진후;이동춘
    • Journal of Korean Society of Industrial and Systems Engineering
    • /
    • v.19 no.39
    • /
    • pp.155-162
    • /
    • 1996
  • It is a common tool to use alphanumeric displays on CRT for documentation, search, and communication. So, it is very important to design ergonomic displays for enhancing user performance. This paper concerns with a method of quantifing the four VDT design parameters such as total density, local density, grouping and layout complexity. A case study to demonstrate the pocedure of quantifing parameters and a comparative analysis between the ready made and the newly designed displays are provided in this paper. Concludingly, ergonomic displays which were designed in accordance with the scientific procedure were much more better than the ready made exampled displays in both of processing time and error rate.

  • PDF