문서화

위키백과 템플릿의 설명서 사용에 대한 가이드는 {{documentation}을(를) 참조하십시오.

문서화는 부품, 조립, 설치, 유지보수 및 사용과 같은 물체, 시스템 또는 절차의 일부 속성에 대해 설명, 설명 또는 지시하는 데 사용되는 모든 전달 가능한 자료다.[1] 문서화는 종이, 온라인 또는 오디오 테이프 또는 CD와 같은 디지털 또는 아날로그 미디어에서 제공될 수 있다. 예로는 사용자 가이드, 백서, 온라인 도움말 및 빠른 참조 가이드 등이 있다. 종이 또는 하드카피 문서가 덜 보편화되었다.[citation needed] 문서화는 종종 웹 사이트, 소프트웨어 제품 및 기타 온라인 응용프로그램을 통해 배포된다.

일련의 지침 자료로서 문서화는 문서 과학, 정보의 기록과 검색에 대한 연구와 혼동해서는 안 된다.

문서 작성 원칙

관련 ISO 표준이 쉽게 공개되지는 않지만, 이 주제에 대한 다른 출처의 지침이 그 목적에 부합할 수 있다.[2],[3],[4][5]

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

문서 작성

기술 저술가와 기업 커뮤니케이션 담당자는 분야와 업무가 문서화된 전문가들이다. 이상적으로 기술 작성자는 주제와 더불어 글쓰기, 콘텐츠 관리, 정보 아키텍처에서도 배경이 있다. 기술 작성자는 기술자, 기술 전문가, 의료 전문가 등과 같은 주제 전문가(SME)와 더 일반적으로 협력하여 사용자의 요구에 맞는 문서를 정의하고 작성한다. 기업 통신에는 다음과 같은 다른 유형의 서면 문서가 포함된다.

  • 시장 통신(MarCom): MarCom 작가들은 다양한 프린트, 전자, 소셜 미디어를 통해 회사의 가치 제안을 전달하기 위해 노력한다. 이러한 기업 글쓰기의 영역은 종종 제안에 응답하는 데 관여한다.
  • 기술 통신(TechCom): 기술 작성자는 회사의 제품 또는 서비스를 문서화한다. 기술 간행물에는 사용자 안내서, 설치 및 구성 설명서, 문제 해결 및 수리 절차가 포함될 수 있다.
  • 법적 작성: 이런 종류의 문서는 종종 변호사나 변호사들에 의해 준비된다.
  • 컴플라이언스 문서: 이 유형의 문서는 안전 승인, 과세, 금융, 기술 승인 및 모든 규제 준수 요구에 대해 표준 운영 절차(SOP)를 규정한다.
  • 의료 문서: 이 문서 분야는 의료 제공 과정에서 발생한 사건에 대한 적시에 기록 및 검증을 포함한다.[10]

컴퓨터 과학의 문서화

주요 기사: 소프트웨어 설명서

종류들

다음은 일반적인 소프트웨어 설명서 유형이다.

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

SDF(소프트웨어 설명서 폴더) 도구

시뮬레이션 산업에서 작성된 소프트웨어 문서의 일반적인 유형은 SDF이다. 임베디드 항전 장치부터 풀모션 제어 시스템을 통해 3D 지형 데이터베이스까지 다양한 시뮬레이터용 소프트웨어를 개발할 때 엔지니어는 프로젝트 또는 모듈의 개발 "구축"을 상세히 기술한 노트북을 보관한다. 이 문서는 위키 페이지, MS 워드 문서 또는 기타 환경일 수 있다. 그들은 소프트웨어의 통신 인터페이스를 상세히 기술하는 요건 섹션, 인터페이스 섹션을 포함해야 한다. 종종 노트 섹션은 개념 증명을 상세히 설명한 다음 오류와 개선 사항을 추적하기 위해 사용된다. 마지막으로, 소프트웨어 테스트 방법을 문서화하는 테스트 섹션. 이것은 고객의 요구에 부합하는 것을 문서화한다. 그 결과는 소프트웨어의 설계 방식, 대상 장치에 소프트웨어를 구축하고 설치하는 방법, 알려진 결함과 해결책에 대한 상세한 설명이 된다. 이 빌드 문서는 미래의 개발자 및 유지관리자가 적시에 소프트웨어에 대한 속도를 높일 수 있도록 하며, 코드를 수정하거나 버그를 검색할 수 있는 로드맵도 제공한다.

네트워크 인벤토리 및 구성을 위한 소프트웨어 도구

이러한 소프트웨어 도구는 네트워크 장비의 데이터를 자동으로 수집할 수 있다. 데이터는 재고용 및 구성 정보용일 수 있다. ITIL 라이브러리는 IT 책임자를 위한 모든 정보의 기초로서 그러한 데이터베이스를 만들 것을 요청한다. IT 문서화의 기초가 되기도 한다. 예로는 XIA 구성을 들 수 있다.[11]

형사재판 문서화

"문서"는 범죄자 데이터베이스를 작성하는 과정에서 선호되는 용어다. 국가 대테러 센터의 테러 신원 데이터마트 환경("TIDE"), 성범죄자 등록지, 갱 데이터베이스 등이 그 예다.[12]

유아교육의 문서화

유아교육 분야와 관련된 문서화는 "어린이들의 사상, 사고, 질문, 이론 등을 우리가 인지하고 가치 있게 평가한 다음, 아이들의 작업 흔적(그림, 행동 중인 아이들의 사진, 말대본)을 수집하여 더 넓은 지역사회와 공유할 때"[13]이다.

따라서 문서화는 아동/아동에 대한 교육자의 지식과 학습을 가족, 다른 협력자, 그리고 아동 자신에게도 연결시키는 데 사용되는 과정이다.

문서화는 관찰, 반영, 문서화, 공유 및 응답이라는 조사 주기의 필수적인 부분이다.[13]

교육학 문서화는 교사 문서화 측면에서, "어린이들의 이해에 있어서의 움직임에 대한 선생님의 이야기"이다.[13] 스테파니 콕스 수아레즈(Stephanie Cox Suarez)는 '문서화 - 우리의 관점을 바꾸는 것'에서 "교사는 연구자로 간주되며, 문서는 어린이와 어른들 사이에서 지식 구축을 지원하는 연구 도구"[14]라고 밝혔다.

문서화는 교실에서 다양한 스타일을 취할 수 있다. 다음은 문서가 '연구' 또는 학습을 가시적으로 만드는 방법을 예시한다.

  1. 문서 패널(프로젝트 또는 이벤트에 대한 여러 그림과 설명이 포함된 게시판과 같은 프레젠테이션).
  2. 매일 로그(교실에서 연극과 학습 내용을 기록하는 로그)
  3. 어린이에 의해 또는 어린이와 함께 개발된 문서(문서화 중 어린이 관찰 시 실제 문서에 어린이의 관찰 렌즈가 사용됨)
  4. 개별 포트폴리오(각 아동의 개발을 추적하고 강조하기 위해 사용되는 문서)
  5. 전자 설명서(앱 및 장치를 사용하여 제품군 및 공동작업자와 문서 공유)
  6. 대화 내용 또는 녹음(문서화 기록 사용으로 교육자와 어린이 모두에게 깊은 반성을 가져올 수 있음)
  7. 학습 스토리("배움을 설명하고 아이들이 자신을 강력한 학습자로 볼 수 있도록 돕는 이야기")[13]
  8. 강의실 문서화(교실의 물리적 환경에 대한 리플렉션 및 문서화)[13]

문서화는 분명히 그 자체로 과정이며 교육자 내부의 과정이기도 하다. 다음은 교육자 자체에 대한 문서화 진행에 따른 발전이다.

  • 문서화 습관 개발
  • 활동 재검표를 통해 공개하는 것이 편안해짐
  • 시각적 읽고 쓰는 능력 개발
  • 문서화의 목적을 학습 스타일을 가시적으로 만드는 것으로 개념화
  • 커리큘럼의 해석 및 추가 설계를 위해 가시적 이론을 공유하십시오.[15]

참고 항목


참조

  1. ^ "Documentation definition by The Linux Information Project". www.linfo.org. Retrieved 9 August 2020.
  2. ^ N/A (2003). "Guide to Documentation" (PDF). Archived from the original (PDF) on 29 July 2007.
  3. ^ CGRP. "A Guide to Documentation Styles" (PDF). Retrieved 12 June 2009.
  4. ^ N/A. "A guide to MLA documentation" (PDF). Archived from the original (PDF) on 2 September 2006. Retrieved 12 June 2009.
  5. ^ Berger, David. "Procedures and Documentation" (PDF). Archived from the original (PDF) on 27 July 2011. Retrieved 15 June 2009.
  6. ^ Cropper, Mark; Tony Dibbens (2002). "GAIA-RVS Documentation Procedures" (PDF). Archived from the original (PDF) on 2 November 2005. Retrieved 15 June 2009.
  7. ^ N/A. "GLNPO's Quality System Documentation Review Procedures and Tracking" (PDF). Archived from the original (PDF) on 4 December 2008. Retrieved 15 June 2009.
  8. ^ UK Data Archive (2009). "Data Services Process Guides: Documentation Processing Procedures" (PDF). Archived from the original (PDF) on 13 June 2010. Retrieved 15 June 2009.
  9. ^ UK Data Archive. "Data Services Process Guides: Documentation Processing Techniques" (PDF). Retrieved 15 June 2009.[데드링크]
  10. ^ Springhouse (2008). Complete Guide to Documentation. p. ix. ISBN 9781582555560. Retrieved 12 June 2009.
  11. ^ "XIA Configuration Network Documentation Tool". Retrieved 8 August 2017.
  12. ^ Rader Brown, Rebecca (2009). "The Gang's All Here: Evaluating the Need for a National Gang Database". Columbia Journal of Law and Social Problems. 42: 293–333.
  13. ^ 위로 이동: Susan, Stacey (11 May 2015). Pedagogical documentation in early childhood : sharing children's learning and teachers' thinking. St. Paul, Minnesota. ISBN 9781605543925. OCLC 909907917.
  14. ^ "Documentation: Transforming our Perspectives Project Zero". www.pz.harvard.edu. Retrieved 26 October 2018.
  15. ^ "ECRP. Vol 13 No 2". ecrp.uiuc.edu. Retrieved 26 October 2018.

외부 링크