테크니컬 문서
Technical documentation |
기술 문서는 제품, 시스템 또는 서비스의 사용, 기능 또는 아키텍처를 기술 언어로 기술하기 위해 작성된 정보 클래스를 총칭하는 용어입니다.
기술 문서의 클래스
기술 문서의 등급은 다음과 같습니다.
- 특허
- 아이템 또는 컴포넌트/컴포함
- 아이템 또는 컴포넌트/컴포넌트 데이터 시트
- 테스트 방법
- 제조 기준
- 시스템 요건
- 시스템 아키텍처
- 시스템 개발, 테스트, 제조, 운용 및 유지보수에 필요한 문서를 포함한 시스템 설계 문서 및 데이터
기술 문서 표준화
지금까지 대부분의 기술 문서 클래스는 형식, 내용 및 구조에 대한 보편적인 적합성(표준)이 결여되어 있었습니다.국제표준화기구(ISO)와 같은 기구를 통해 이를 교정하기 위한 표준이 개발되고 있습니다.ISO는 기술제품 문서 작성에 관한 사용자 가이드, 매뉴얼, 제품 사양 등의 규칙과 관련된 표준을 발행하고 있습니다.이러한 규격은 ICS 01.[1]110의 적용을 받습니다.ICS 01.110에서 다루지 않는 기술 제품 매뉴얼은 다음 항에 기재되어 있습니다.
분야별
EU 의료기기 규제
또한 EU 의료기기 규정에 따른 의료기기에 대한 기술 문서도 필요하다.규정의 부록 II, 기술 문서 및 사후 시장 감시에 관한 기술 문서 부록 III는 의료기기에 대한 기술 문서의 내용을 설명한다.여기에는 예를 들어 기기 규격, 라벨링 및 지침, 설계 및 제조, 안전 및 성능 요건, 위험 관리 및 임상 평가를 종료할 때 기기의 검증 및 검증에 대한 정보와 시판 후 감시의 정보가 포함된다.
소스 데이터 형식
문서 아키텍처 및 타이핑
일부 문서 시스템은 문서 세트를 구성하는 전체 유형 또는 문서 형식에 관한 것뿐만 아니라 문서의 작성, 발행 또는 형식 지정 방법에 관한 것입니다.
예를 들어 DiaaStaxis 프레임워크(소프트웨어 문서 분야에서 주로 사용됨)에는 4가지 다른 사용자 요구(튜토리얼, 사용법 가이드, 레퍼런스 및 설명)[9]에 대응하는 4가지 다른 문서 양식이 있습니다.반면 DITA는 5가지 다른 '토픽 유형'을 주장하고 있습니다.작업, 개념, 참조, 용어집 입력 및 문제 해결. RedHat의 모듈식 문서 시스템에는 다음 세 가지 "모듈"이 사용됩니다.개념, 절차 및 참조.[10]
「 」를 참조해 주세요.
인용문
- ^ "01.110: Technical product documentation". International Organization for Standardization. Retrieved 10 June 2009.
- ^ "ISO 15787:2001 Technical product documentation -- Heat-treated ferrous parts -- Presentation and indications". International Organization for Standardization. Retrieved 10 June 2009.
- ^ "ISO 3098-0:1997 Technical product documentation -- Lettering -- Part 0: General requirements". International Organization for Standardization. Retrieved 10 June 2009.
- ^ "ISO 10209-1:1992 Technical product documentation -- Vocabulary -- Part 1: Terms relating to technical drawings: general and types of drawings". International Organization for Standardization. Retrieved 10 June 2009.
- ^ "ISO 2162-1:1993 Technical product documentation -- Springs -- Part 1: Simplified representation". International Organization for Standardization. Retrieved 10 June 2009.
- ^ "ISO 5457:1999 Technical product documentation -- Sizes and layout of drawing sheets". International Organization for Standardization. Retrieved 10 June 2009.
- ^ ISO6433 Technical product documentation. Part references, BSI British Standards, retrieved 2020-12-16
- ^ "Partial list of Diátaxis documentation sets". Retrieved 10 April 2021.
- ^ "Outline of Diátaxis documentation forms". Retrieved 10 April 2021.
- ^ "RedHat Modular Documentation terms and definitions". Retrieved 11 April 2021.
