맨위로가기

문서화

"오늘의AI위키"는 AI 기술로 일관성 있고 체계적인 최신 지식을 제공하는 혁신 플랫폼입니다.
"오늘의AI위키"의 AI를 통해 더욱 풍부하고 폭넓은 지식 경험을 누리세요.
목차

1. 개요

문서화는 기록된 정보의 조직화, 축적, 검색, 유통 및 평가를 의미하며, 범죄 데이터베이스, 소프트웨어 개발, 유아 교육, 미술 등 다양한 분야에서 사용된다. 문서 개발은 초안 작성, 서식 지정, 검토, 승인, 배포 등을 포함하며, 읽기 쉽고 간결하게 작성되어야 한다. 소프트웨어 문서화에는 제안 요청, 요구 사항, 설계 명세 등이 포함되며, 유아 교육에서는 아이들의 생각과 학습 과정을 기록하고 공유하는 과정으로 사용된다. 미술 분야에서는 작품에 대한 정보와 연구 데이터를 수집, 분석하여 데이터베이스 형태로 제공하는 활동을 의미한다. 문서화 관련 표준으로는 ISO 690과 ISO 5964가 있다.

더 읽어볼만한 페이지

  • 기술 소통 - 교열
    교열은 글의 명확성과 정확성을 높이기 위해 문법, 용법, 내용, 구성 요소 간의 관계 등을 고려하여 오류를 수정하고 재구성하는 복잡한 과정으로, 디지털 환경 변화에 따라 역할이 재정립되고 있다.
  • 기술 소통 - 국제화와 지역화
    국제화는 소프트웨어를 다양한 언어와 지역을 지원하도록 설계하는 과정이며, 지역화는 특정 언어와 지역에 맞춰 조정하는 과정으로, 문자 인코딩, 날짜/시간 형식, 통화, 법적 규제, 문화적 차이 등을 고려하여 제품을 적응시키는 것을 의미한다.
  • 정보과학 - 시소러스
    시소러스는 특정 단어나 개념의 유의어, 상위어, 하위어를 모아놓은 사전으로, 어휘의 의미 관계를 보여주며 글쓰기, 번역 등 다양한 분야에 활용된다.
  • 정보과학 - 지식 표현
    지식 표현은 컴퓨터가 인간의 지식을 이해하고 활용하도록 정보를 구조화하는 기술이며, 표현력과 추론 효율성의 균형, 불확실성 처리 등을 핵심 과제로 다양한 기법과 의미 웹 기술을 활용한다.
문서화
기본 정보
프랑스어 설명서 샘플
프랑스어 설명서 샘플
분야다양한 분야
유형문서
목적시스템 설명
개요
정의문서화는 시스템, 소프트웨어, 하드웨어 또는 기타 엔터티에 대한 서면, 시각 또는 오디오 자료 집합을 의미함.
포함 내용개념
튜토리얼
API 참조
프로세스
목적시스템 사용, 수정 또는 유지 보수 방법을 설명
중요성
역할시스템의 효율적인 사용과 이해를 도움
대상최종 사용자, 개발자, 유지 보수 담당자
종류
사용자 설명서최종 사용자를 위한 시스템 사용법 설명
개발자 문서개발자를 위한 시스템 구조 및 API 설명
기술 문서시스템의 기술적 세부 사항 설명
마케팅 문서시스템의 기능과 장점 홍보
작성 과정
계획문서의 목표, 범위, 대상을 정의
연구시스템의 기능과 특징을 분석
작성문서 작성 및 시각 자료 제작
편집내용의 정확성, 일관성, 가독성 검토
배포문서 배포 및 피드백 수집
참고 자료
관련 자료README 파일
API 문서
기술 사양서
디자인 문서
고려 사항
정확성내용이 정확하고 최신 정보를 반영해야 함
명확성이해하기 쉽고 간결하게 작성되어야 함
완전성필요한 모든 정보를 포함해야 함
접근성대상 사용자가 쉽게 접근하고 사용할 수 있어야 함
유지 보수성변경 사항을 쉽게 반영하고 업데이트할 수 있어야 함

2. 문서화의 정의 및 원칙

문서화는 범죄 데이터베이스를 생성하는 과정에서 선호되는 용어이다. 국가테러대책센터의 테러리스트 아이덴티티 데이터마트 환경(TIDE), 성범죄자 레지스트리, 갱 데이터베이스 등이 그 예이다.[22] 문서화 관련 국제 표준화 기구(ISO) 표준은 공개적으로 쉽게 구할 수 없다.[2][3][4][5]

2. 1. 정의

국제 문서화 연맹에 따르면, 문서화는 "과학, 기술, 사회 과학, 학예 및 인문 과학 분야에서 기록된 정보의 조직화, 축적, 검색, 유통 및 평가"를 의미한다.[17]

2. 2. 문서 작성 원칙

문서 개발은 문서 초안 작성, 서식 지정, 제출, 검토, 승인, 배포, 재게시 및 추적 등을 포함할 수 있으며, 규제 산업과 관련된 표준 작업 절차에 따라 소집된다. 또한 처음부터 콘텐츠를 만드는 것도 포함될 수 있다. 문서는 읽고 이해하기 쉬워야 한다. 너무 길고 장황하면 오해하거나 무시할 수 있다. 명확하고 간결한 단어를 사용해야 하며, 문장은 최대 15단어로 제한해야 한다. 일반 대중을 대상으로 하는 문서는 성별 관련 용어와 문화적 편견을 피해야 한다. 일련의 절차에서는 단계를 명확하게 번호 매겨야 한다.[6][7][8][9]

3. 문서화의 유형

문서화는 다양한 분야에서 다양한 형태로 나타난다.


  • 범죄 정의 분야: 범죄 데이터베이스를 만드는 과정을 의미하며, 국가테러대책센터의 테러리스트 아이덴티티 데이터마트 환경(TIDE), 성범죄자 레지스트리, 갱 데이터베이스 등이 그 예시이다.[22]
  • 유아 교육 분야: 아이들의 생각과 학습 과정을 기록하고 공유하는 것을 의미한다. 교육자가 아이들의 학습을 이해하고, 가족 및 동료들과 협력하는 데 사용된다.[13]
  • 미술 분야: 미술 작품 및 관련 정보를 수집, 정리, 보존하는 활동을 의미한다. 미술관, 갤러리, 연구 기관 등에서 전시회, 제작 과정, 작품 배경 등을 기록하는 것과, 랜드 아트, 컨셉추얼 아트 등 직접 체험이 어려운 작품을 기록하여 감상자에게 제공하는 것을 포함한다.[18]
  • 기타 분야: 소프트웨어 문서화, 명세서, 기획서, 도서 문서화 등이 있다.

3. 1. 컴퓨터 과학 분야

컴퓨터 과학 분야에서 일반적인 소프트웨어 문서화 유형은 다음과 같다.

  • 제안 요청
  • 요구 사항/작업 명세서/작업 범위
  • 소프트웨어 설계 및 기능 명세
  • 시스템 설계 및 기능 명세
  • 변경 관리, 오류 및 개선 사항 추적
  • 사용자 인수 테스트
  • 매뉴얼 페이지


일반적인 하드웨어 및 서비스 문서화 유형은 다음과 같다.

시뮬레이션 업계에서 작성되는 일반적인 유형의 소프트웨어 문서 중 하나는 SDF(Software Documentation Folder)이다. 임베디드 항공 전자 장치에서부터 3D 지형 데이터베이스, 풀 모션 제어 시스템에 이르기까지 시뮬레이터를 위한 소프트웨어를 개발할 때, 엔지니어는 프로젝트 또는 모듈의 개발 "빌드"를 자세히 설명하는 노트를 작성한다. 문서는 위키 페이지, Microsoft Word 문서 또는 다른 환경이 될 수 있다. 여기에는 소프트웨어의 통신 인터페이스를 자세히 설명하는 ''요구 사항'' 섹션과 ''인터페이스'' 섹션이 포함되어야 한다. 종종 ''노트'' 섹션은 개념 증명을 자세히 설명하고 오류 및 개선 사항을 추적하는 데 사용된다. 마지막으로, 소프트웨어가 어떻게 테스트되었는지 문서화하는 ''테스트'' 섹션이 있다. 이는 클라이언트의 요구 사항 준수를 문서화한다. 결과적으로 소프트웨어 설계 방식, 대상 장치에 소프트웨어를 빌드 및 설치하는 방법, 알려진 결함 및 해결 방법에 대한 자세한 설명이 제공된다. 이 빌드 문서를 통해 향후 개발자 및 유지 관리자는 적시에 소프트웨어에 대한 이해를 높일 수 있으며, 코드 수정 또는 버그 검색에 대한 로드맵을 제공한다.

3. 2. 범죄 정의 분야

"문서화"는 범죄 데이터베이스를 생성하는 과정에서 선호되는 용어이다. 예로는 국가테러대책센터의 테러리스트 아이덴티티 데이터마트 환경(TIDE), 성범죄자 레지스트리, 갱 데이터베이스 등이 있다.[22]

3. 3. 유아 교육 분야

유아 교육 분야에서 문서화는 "우리가 아이들의 아이디어, 사고, 질문 및 세상에 대한 이론을 인지하고 가치를 부여한 다음, 그들의 작업 흔적(그림, 행동하는 아이들의 사진, 그들의 말에 대한 기록)을 수집하여 더 넓은 공동체와 공유하는 것"을 의미한다.[13] 따라서 문서화는 교육자의 지식과 아동 및 아동 학습을 가족, 다른 협력자, 심지어 아동 자신과 연결하는 데 사용되는 과정이다.

문서화는 탐구의 순환(관찰, 성찰, 문서화, 공유 및 응답)의 필수적인 부분이다.[13]

교사 문서화 측면에서 교육적 문서화는 "아동의 이해에 대한 교사의 이야기"이다.[13] 스테파니 콕스 수아레즈는 "문서화 - 우리의 관점을 바꾸다"에서 "교사는 연구자로 간주되며, 문서화는 아동과 성인 간의 지식 구축을 지원하는 연구 도구"라고 말한다.[14]

문서화는 교실에서 다양한 스타일을 취할 수 있다. 다음은 문서화가 연구 또는 학습을 가시화할 수 있는 방식을 예시한다.

  • 문서화 패널 (프로젝트 또는 이벤트에 대한 여러 그림과 설명이 있는 게시판과 유사한 프레젠테이션).
  • 일일 기록부 (교실에서의 놀이와 학습을 기록하는 매일 기록하는 일지)
  • 아동이 개발하거나 아동과 함께 개발한 문서화 (문서화 중에 아동을 관찰할 때, 관찰에 대한 아동의 시각이 실제 문서화에 사용됨)
  • 개별 포트폴리오 (각 아동의 발달을 추적하고 강조하는 데 사용되는 문서화)
  • 전자 문서화 (앱 및 장치를 사용하여 가족 및 협력자와 문서화 공유)
  • 대화 내용 기록 또는 녹음 (문서화에 녹음을 사용하면 교육자와 아동 모두에게 더 깊은 성찰을 가져올 수 있음)
  • 학습 이야기 ("학습을 설명하고 아이들이 스스로를 강력한 학습자로 보도록 돕는" 데 사용되는 이야기)[13]
  • 문서화로서의 교실 (교실의 물리적 환경에 대한 성찰 및 문서화).[13]


문서화는 그 자체로 하나의 과정이며, 교육자 내에서도 과정이다. 다음은 교육자 자신을 위해 그리고 교육자 안에서 문서화가 진행됨에 따라 나타나는 발전이다.

  • 문서화 습관 개발
  • 활동 기록을 공개하는 데 익숙해짐
  • 시각적 문해력 기술 개발
  • 학습 스타일을 가시화하는 것을 문서화의 목적으로 개념화
  • 해석 목적 및 커리큘럼의 추가 설계를 위해 가시적인 이론 공유[15]

3. 4. 미술 분야

미술 자료의 수집·정리·보존 등의 활동에서 아트 도큐멘테이션(Art Documentation)이라는 말을 사용하는 경우가 있다[18]. 가무라 테츠로에 따르면, 아트 도큐멘테이션이란, "미술관이나 갤러리가 작성한 작품 목록이나 작가 자신이 기술한 문장 등, 작품에 직접 관련된 정보(박물관 자료에서의 2차 자료) 외에, 작품에 관해 쓰인 서적이나 잡지 등의 서지 정보나 연구자에 의한 연구 데이터, 학술 논문 등 간접적인 정보를 널리 수집·분석하여, 그 성과를 데이터베이스 등의 형태로 사회에 발신하는 미술 정보를 학제적으로 다루는 연구 활동"이라고 한다. 그러나 아트 도큐멘테이션이라는 말은 널리 일반적으로 인지되고 있다고는 말하기 어렵고, 해외에서는 Art Archive(s), Museum Archive(s), Archive Collection 등으로 표기되는 경우가 많다. 또한, 일련의 도큐멘테이션 활동은 미술 도서관의 업무의 일환으로 인식되고 있으며, 실제로 이러한 활동에는 미술 도서관의 국제적인 연계 조직인 미술 도서관 협회가 연구 활동의 장으로서 기능하고 있다. 국내에는 학술 단체 "[http://www.jads.org 아트 도큐멘테이션 학회]"가 있다.

아트 도큐멘테이션에는 두 가지 의미가 있다. 첫째는, 미술관·박물관·연구 기관·관련 미디어가 각자의 역할 안에서 남기는 전시회·제작 과정·작품 배경 등의 기록이며, 둘째는, 직접 체험이 어려운 작품을 작가에 소속된 것으로서 감상자에게 제공하는 기록이다[19]. 후자에 대해서는, 랜드 아트, 컨셉추얼 아트, 퍼포먼스 아트, 게릴라 아트 등의 가운데, 야외에서 행할 필요성이 있는 것이나 일회성이 중시되는 예술 행위에서 특히 사용된다.

아트 도큐멘테이션은, 옛날에는 프랑스의 루브르 박물관이나 오르세 미술관의 자료실 내 활동에서 사용되고 있는 Centre de Documentation(통칭 도큐멘타시옹)에서 볼 수 있다[20]. 작가나 유파에 관한 정보의 수집, 소장 작품 한 점마다 관련된 논문, 사무적인 자료, 메모 등의 종이 조각, 전시회 카탈로그의 정보 수집·정리가 그 활동 내용이었다[21].

3. 5. 기타 분야

4. 문서화 관련 직업

기술 문서 작가 및 기업 커뮤니케이터는 문서화를 전문 분야로 하는 전문가이다. 기술 문서 작가는 주제에 대한 배경 지식과 글쓰기, 콘텐츠 관리 및 정보 아키텍처에 대한 지식을 갖추고 있다. 기술 문서 작가는 일반적으로 엔지니어, 기술 전문가, 의료 전문가 등과 같은 주제 전문가와 협력하여 사용자의 요구 사항을 충족하는 문서를 정의하고 생성한다.[10]

기업 커뮤니케이션에는 다음과 같은 다른 유형의 문서가 포함된다.[10]


  • 마케팅 커뮤니케이션(MarCom): MarCom 작가는 다양한 인쇄물, 전자 매체 및 소셜 미디어를 통해 회사의 가치 제안을 전달한다. 이 기업 글쓰기 분야는 종종 제안에 대응하는 데 관여한다.[10]
  • 기술 커뮤니케이션(TechCom): 기술 작가는 회사의 제품 또는 서비스를 문서화한다. 기술 출판물에는 사용자 가이드, 설치 및 구성 매뉴얼, 문제 해결 및 수리 절차가 포함될 수 있다.[10]
  • 법률 문서 작성: 이러한 유형의 문서는 변호사 또는 법률 보조원에 의해 작성되는 경우가 많다.[10]
  • 규정 준수 문서: 이러한 유형의 문서는 안전 승인, 과세, 금융 및 기술 승인과 같은 모든 규정 준수 요구 사항에 대한 표준 운영 절차를 문서화한다.[10]
  • 의료 문서: 이 문서 분야는 의료를 제공하는 과정에서 발생한 사건을 적시에 기록하고 검증하는 것을 포함한다.[10]

5. 문서화 관련 표준

문서화와 관련된 국제 표준화 기구(ISO) 표준은 공개적으로 쉽게 구할 수 없지만, 이 주제에 대한 다른 출처의 가이드는 그 목적을 달성할 수 있다.[2][3][4][5]

문서 개발은 문서 초안 작성, 서식 지정, 제출, 검토, 승인, 배포, 재게시 및 추적 등을 포함할 수 있으며 규제 산업과 관련된 표준 작업 절차에 따라 소집된다. 또한 처음부터 콘텐츠를 만드는 것도 포함될 수 있다. 문서는 읽고 이해하기 쉬워야 한다. 너무 길고 장황하면 오해하거나 무시할 수 있다. 명확하고 간결한 단어를 사용해야 하며 문장은 최대 15단어로 제한해야 한다. 일반 대중을 대상으로 하는 문서는 성별 관련 용어와 문화적 편견을 피해야 한다. 일련의 절차에서는 단계를 명확하게 번호 매겨야 한다.[6][7][8][9]


  • ISO 690: 정보 및 문서화
  • ISO 5964: 문서화 - 다국어 시소러스

6. 문서화 도구

시뮬레이션 업계에서 작성되는 일반적인 유형의 소프트웨어 문서 중 하나는 SDF(Software Documentation Folder)이다. 임베디드 항공 전자 장치에서부터 3D 지형 데이터베이스, 풀 모션 제어 시스템에 이르기까지 시뮬레이터를 위한 소프트웨어를 개발할 때, 엔지니어는 프로젝트 또는 모듈의 개발 "빌드"를 자세히 설명하는 노트를 작성한다. 문서는 위키 페이지, Microsoft Word 문서 또는 다른 환경이 될 수 있다. 여기에는 소프트웨어의 통신 인터페이스를 자세히 설명하는 ''요구 사항'' 섹션과 ''인터페이스'' 섹션이 포함되어야 한다. 종종 ''노트'' 섹션은 개념 증명을 자세히 설명하고 오류 및 개선 사항을 추적하는 데 사용된다. 마지막으로, 소프트웨어가 어떻게 테스트되었는지 문서화하는 ''테스트'' 섹션이 있다. 이는 클라이언트의 요구 사항 준수를 문서화한다. 결과적으로 소프트웨어 설계 방식, 대상 장치에 소프트웨어를 빌드 및 설치하는 방법, 알려진 결함 및 해결 방법에 대한 자세한 설명이 제공된다. 이 빌드 문서를 통해 향후 개발자 및 유지 관리자는 적시에 소프트웨어에 대한 이해를 높일 수 있으며, 코드 수정 또는 버그 검색에 대한 로드맵을 제공한다.

이러한 소프트웨어 도구는 네트워크 장비의 데이터를 자동으로 수집할 수 있다. 데이터는 인벤토리 및 구성 정보를 위해 사용될 수 있다. IT 인프라 라이브러리는 IT 담당자를 위한 모든 정보의 기반으로서 이러한 데이터베이스를 구축할 것을 요청한다. 이는 또한 IT 문서화의 기반이기도 하다. 예를 들어 XIA Configuration이 있다.[11]

참조

[1] 웹사이트 Documentation definition by The Linux Information Project http://www.linfo.org[...] 2020-08-09
[2] 웹사이트 Guide to Documentation https://web.archive.[...] 2007-07-29
[3] 웹사이트 A Guide to Documentation Styles https://web.archive.[...] 2011-01-05
[4] 웹사이트 A guide to MLA documentation https://web.archive.[...] 2006-09-02
[5] 웹사이트 Procedures and Documentation https://web.archive.[...] 2011-07-27
[6] 웹사이트 GAIA-RVS Documentation Procedures https://web.archive.[...] 2005-11-02
[7] 웹사이트 GLNPO's Quality System Documentation Review Procedures and Tracking https://wayback.arch[...] 2008-12-04
[8] 웹사이트 Data Services Process Guides: Documentation Processing Procedures https://web.archive.[...] 2010-06-13
[9] 웹사이트 Data Services Process Guides: Documentation Processing Techniques http://www.esds.ac.u[...] 2016-05-01
[10] 서적 Complete Guide to Documentation https://books.google[...] Lippincott Williams & Wilkins 2009-06-12
[11] 웹사이트 XIA Configuration Network Documentation Tool https://www.centrel-[...] 2017-08-08
[12] 저널 The Gang's All Here: Evaluating the Need for a National Gang Database
[13] 서적 Pedagogical documentation in early childhood : sharing children's learning and teachers' thinking https://books.google[...] 2015-05-11
[14] 웹사이트 Documentation: Transforming our Perspectives http://www.pz.harvar[...] 2018-10-26
[15] 웹사이트 ECRP. Vol 13 No 2 https://web.archive.[...] 2018-10-27
[16] 웹사이트 ドキュメンテーション 【documentation】 文書化 / ドキュメント化 https://e-words.jp/w[...] 2020-06-30
[17] 저널 画像ドキュメンテーションの新世界 https://dl.ndl.go.jp[...] 日本文書情報マネジメント協会 1994
[18] 웹사이트 芸術資料とアーカイブ／ドキュメンテーション https://current.ndl.[...] 国立国会図書館 2015-06
[19] 웹사이트 ドキュメンテーション https://artscape.jp/[...] 大日本印刷株式会社
[20] 저널 MLAの融合と情報専門職-ミュージアム、ライブラリー、アーカイブの未来 駿河台大学 2008
[21] 저널 美術研究支援情報資源の集中と分散-フランスにおける美術館・図書館・情報システムの特性をめぐって 国立西洋美術館 1997
[22] 저널 The Gang's All Here: Evaluating the Need for a National Gang Database


본 사이트는 AI가 위키백과와 뉴스 기사,정부 간행물,학술 논문등을 바탕으로 정보를 가공하여 제공하는 백과사전형 서비스입니다.
모든 문서는 AI에 의해 자동 생성되며, CC BY-SA 4.0 라이선스에 따라 이용할 수 있습니다.
하지만, 위키백과나 뉴스 기사 자체에 오류, 부정확한 정보, 또는 가짜 뉴스가 포함될 수 있으며, AI는 이러한 내용을 완벽하게 걸러내지 못할 수 있습니다.
따라서 제공되는 정보에 일부 오류나 편향이 있을 수 있으므로, 중요한 정보는 반드시 다른 출처를 통해 교차 검증하시기 바랍니다.

문의하기 : help@durumis.com