• Title/Summary/Keyword: Architecture Documentation

Search Result 58, 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.

UML based Documentation for GLORY Software Architecture (UML을 응용한 GLORY 소프트웨어 아키텍처의 표현)

  • Kung, Sang-Hwan
    • Journal of the Korea Academia-Industrial cooperation Society
    • /
    • v.10 no.8
    • /
    • pp.1970-1976
    • /
    • 2009
  • It is more emphasized on the software architecture recently, as the scale of a software becomes huge and the need of the software management becomes more dynamic. Software architecture is a representation of structures of software framework just like the blueprint of building architecture. In order to describe software components and their relationships accurately and entirely, software architecture is documented in some different views, by using of modeling tools. UML(Unified Modeling Language) is a software modeling tool recently used for documentation of software and as well as software architecture. Nevertheless, what we have to agree with is that UML is not easy to use and its standard changed continuously. And also the documentation with UML is found some burden because of its difficulties in learning and using. This inconvenience enforces us to purchase and use commercial tool for UML. The study introduces the architecture views refined from 4+1 Views for architecture design and shows how to represent architecture views for software architecture. Especially, we simplifies UML diagrams for the purpose of focusing on architecture views and facile manipulation. At the end, we add the evaluation on the refined architecture views as well as refined UML diagram.

A Study on the Utilization of Documentation using BIM on Wooden Architectural Cultural Assets (BIM을 적용한 목조건축문화재 기록데이터 활용방안에 관한 연구)

  • Shin, Byeong-Uk
    • Journal of the Korean Institute of Rural Architecture
    • /
    • v.21 no.4
    • /
    • pp.25-36
    • /
    • 2019
  • The purpose of the study is to analyze how to document survey and repair data on wooden architecture culture assets. Documentation was analyzed in comparison to digital developments from the past to the present. Although the accuracy of survey equipment has been improved by digital development, survey drawing has not changed. For example, a 3D Scanner, survey equipment, was introduced but is being used for conversion into 2D data. Data provided by the drawing included in the survey and repair reports were not accumulated. As it stands, it is inaccessible and disorganized. Data generated from the survey, repair, and maintenance has to be consistent. A BIM system was proposed to integrate information on wooden architecture cultural assets.

A study on the Heritage Documentation Programs of the United States (미국 문화유산 기록화 프로그램에 관한 연구)

  • Choi, Sun-young;Lee, Seung-hwi
    • The Korean Journal of Archival Studies
    • /
    • no.49
    • /
    • pp.77-119
    • /
    • 2016
  • A modern architectural building is a cultural heritage, which is also part of our history until the present. Documentation is thus considered an irreplaceable method to preserve our cultural heritage as it may be the last resort of preservation. The study analyzed the Historic American Buildings Survey (HABS) on the Heritage Documentation Programs of the National Park Service. Based on the analysis of the comparison and documentation of the modern architectural building implemented by the Cultural Heritage Administration, the study suggested improvement plans from three different perspectives. First, specifically detailed regulations of the legal system are supposed to be used for the implementation of the documentation of modern architectural buildings. Second, it is suggested that a general plan for continuous documentation be made. Last, by setting up a collection method, an information service needs to be provided for the public.

Approaching Content Reuse for Efficient Technical Documentation (효율적인 기술문서화를 위한 콘텐트 재사용성 접근방법)

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

Three-dimensional Digital Documentation and Accuracy Analysis of the Choijin Lama Temple in Mongolia

  • Jo, Young Hoon;Park, Jun Huyn;Hong, Eunki;Han, Wook
    • Journal of Conservation Science
    • /
    • v.36 no.4
    • /
    • pp.264-274
    • /
    • 2020
  • The Choijin Lama Temple is a representative example of 19th- to 20th-century architecture. The temple has been damaged by various development pressures and the effect of a harsh continental climate. This study digitalized the entire temple site using three-dimensional scanning to establish the basic data of conservational management and monitoring for spatial changes. A terrestrial laser scanning model of the temple was completed, which showed low registering error vectors (3.73 mm average) and dense point distances. Unmanned aerial vehicle (UAV) photogrammetry was also applied to verify its applicability to the spatial and environmental monitoring of the temple. The results showed that the overall point density of the UAV photogrammetry model is similar within a 10 mm resolution. The relatively low RMSE of UAV photogrammetry from the ground to the uppermost roof indicates the high applicability of integrating it with the terrestrial laser scanning model. The digital documentation of the Choijin Lama Temple is expected to have a great ripple effect on the documentation, conservation, and utilization of Mongolian cultural heritage sites.

Survey Analysis on the Application of Computer Software in Landscape Architecture (조경분야에서 컴퓨터 이용의 실태분석)

  • 허상현
    • Journal of the Korean Institute of Landscape Architecture
    • /
    • v.29 no.3
    • /
    • pp.81-89
    • /
    • 2001
  • The purpose of this research is to provide for some useful data for computer-related courses of the landscape science, assuming that computers are being and should be used more and more in landscape architecture and therefore, that landscape science students need to respond positively to such a trend. For this purpose, landscape architecture studios and their landscape architects were surveyed for their computer and its program uses as well as their satisfaction with the utility of computer for their landscape works. The results of this research are as follows; 1) 10.7% of the landscape architects surveyed answered that they had learned about their necessary softwares at school, while 61.6% of the studios surveyed were less satisfied with their employees' poor computing ability. Such findings suggest a lack of computer-related courses in landscape science and therefore, that more computer-related courses should be introduced for landscape science students together with the necessary software education. 2) Too few landscape softwares are being used by the landscape architecture studios; such softwares as AutoCAD, Photoshop, 3D Max, Excel, PowerPoint and 한글 account for more than 90% of the landscape architecture softwares being used currently. Quite naturally, landscape students need to be trained on these softwares above all. 3) It was found hat he area of work using the computer most was ˝design works˝(84.5%), followed by ˝documentation˝(83.8%), ˝image editing˝(75.1%), ˝cost calculation˝(68.2%), ˝presentation˝(68.1%), ˝analysis˝(37.8%) and ˝rendering˝(35%). It was regretable to discover that such areas requiring more computing work as ˝analysis˝ and ˝rendering˝ were still worked manually. So it sis deemed necessary for landscape science courses to enhance their computer education of such areas first of all.

  • PDF

An Extensive Model on Essential Elements of Software Architecture (소프트웨어 아키텍처의 구성요소에 대한 포괄적 모델)

  • Koh, Seok-Ha
    • Journal of Information Technology Applications and Management
    • /
    • v.19 no.2
    • /
    • pp.135-147
    • /
    • 2012
  • Software architecture, as a blueprint for the system, should provide a robust foundation for design, implementation, and maintenance, for communication and documentation, and for reasoning about important system properties. Software architecture plays a central role during the whole software life-cycle. There are so diverse definitions of the software architecture, however, and there is no common agreement about what software architecture is. Examining 27 'published' definitions of software architecture, we synthesize an extensive model on the essential elements of software architecture, which consists of components, interaction among components, well-formed structure, reasons, and various perspectives. Further, we explore the possibility of unifying diverse software architecture definitions into a software architecture life-cycle model.

Trend Analysis of Documenting the Gardens of Old Houses with the Measurement Drawings of National Folklore Cultural Heritage (국가민속문화재의 실측도면을 통해 살펴본 고택 정원의 기록화 경향 분석)

  • LIM, Cheyeon;LEE, Jaeyong
    • Korean Journal of Heritage: History & Science
    • /
    • v.55 no.3
    • /
    • pp.46-58
    • /
    • 2022
  • This study analyzed the documentation trend of garden components such as plants, infrastructure, unit facilities, and structures, based on 188 measurement drawings of 94 old houses in a report on the documentation of the national folklore cultural heritage. The findings are as follows. First, it was found that plants and structures continuously appeared as the subject of measurement drawings, while infrastructure was often omitted. It was confirmed that unit facilities, which are smaller than other components, were frequently excluded from the documentation subject as well due to frequent changes such as movement, loss, and expansion. Second, the level of expression in measurement drawings showed different aspects for each component. The unit facilities showed a large change over time with respect to the level of documentation, and the level of documentation was somewhat polarized, particularly toward the latter stage. This suggests that the level of documenting the drawings limited to specific facilities improved, but the overall level of drawings did not improve, such as a lack of diversification of expression techniques suitable for various unit facilities. On the other hand, it was confirmed that the level of documenting the drawings for plants, infrastructure and structures did not change to a significant degree, implying that no improvements were made to the expression of components. Third, as for the technique of detailed expression, in the case of plants, vegetation status was prepared without distinction of old or protected trees that have historical value. Above all, there was no record of the vegetation structure that could help grasp the vegetation landscape of the outer area. As for the infrastructure, there was no consistent expression technique to systematically convey topographic changes such as the height and slope of the land. In addition, since there was no subtype classification defined for unit facilities and structures, there was no subject or method of documentation. This study is meaningful in that it expanded the category of documentation, which has been concentrated on buildings in old houses, to gardens, and called attention to the need for documenting the gardens for the preservation and management of old houses as an integration of the building and outer area.

Software Architecture Documentation based on UML (UML 기반의 소프트웨어 아키텍처 표현방법)

  • Kung, Sang-Hwan
    • Proceedings of the KAIS Fall Conference
    • /
    • 2008.05a
    • /
    • pp.275-277
    • /
    • 2008
  • 본 논문에서는 UML을 이용하여 소프트웨어 아키텍처를 표현하는 방법을 소개하고, 복수의 뷰를 통한 아키텍처를 문서화하는 방법을 설명한다. 무엇보다 논문의 핵심은 UML의 다이어그램이 복잡하여 특별한 편집도구 없이는 표현이 불가능한 점을 반영하여, UML의 표현방법을 개선하고 이를 아키텍처뷰의 표현에 적용한 점이라고 할 수 있다.

  • PDF