Techdocs의 종류

이 온라인 기술 문서 작성 책은 이제 사용합니다 기술 문서 (기술 문서 줄여서) 기술 정보를 포함하는 모든 문서를 지칭하기 위해—사용하는 대신 보고서. 이 보고서는 이 책에서 논의된 다른 종류의 기술 문서들과 함께 하위 범주에 속한다.

참고: 이 기술 문서 작성 교재는 ...에 중점을 둡니다 기술 문서 작성 능력. 여기에 있는 기술적 내용은 정확하거나 최신 정보를 보장하지 않습니다.

배경/정보 보고서

이 유형은 정의하기에 가장 어려운 유형이지만 대부분의 사람들이 쓰는 유형이다. 기술적 주제에 초점을 맞추며, 그 주제에 대해 특정한 요구를 가진 특정 독자 집단을 위해 배경 정보를 제공한다. 이 보고서는 지침을 제공하지 않으며, 체계적인 방식으로 권고를 제시하지도 않고, 새롭고 독창적인 데이터를 보고하지도 않는다.

이 유형 의 기술 문서에 대한 전체 장은, 다음을 참조하십시오 배경/정보성 보고서

사업 계획

사업 계획서는 새로운 사업을 시작하거나 중대한 방식으로 변화하는 사업에 자금을 조달받기 위해 사용하는 문서입니다. 사업 계획서는 계획에 동의해야 하는 사업 파트너들, 그 계획을 승인해야 하는 정부 관계자들, 그리고 물론 사업에 자금을 대줄 수 있는 은행이나 개인 투자자와 같은 잠재적 투자자들에게 중요한 문서입니다.

다음을 참조하세요 전체 장 이러한 유형의 기술 문서에 대해.

기술 중심의 사용자 안내서

간단히 정의하면, 컴퓨터 사용자 안내서는 컴퓨터 하드웨어 또는 소프트웨어를 사용하는 방법에 대한 기술 정보를 제공하며, 설치, 구성 및 필수 작업과 같은 작업에 대한 지침을 포함합니다.

다음을 보세요 완성된 장 이런 종류의 기술 문서에 대해.

데이터 보고서

데이터 보고서는 표의 형태로 많은 데이터를 포함하는 기술 문서이다. 또한 표의 데이터를 보다 생생하게 보여주는 차트와 그래프, 그리고 표의 데이터에서 주요 경향과 결론을 설명하는 교차 참조를 포함할 수도 있다.

그것을 보세요 전체 장 이 유형의 기술 문서에 대해.

공학 설계 보고서

공학 설계 보고서는 공학 설계 프로젝트를 소개하고 문서화하여 다른 사람들이 그 설계가 어떻게 적용되고 상용화될 수 있는지 이해할 수 있도록 한다. 예를 들어, 공학 학생들은 마이크로컨트롤러를 사용한 온도 측정 및 표시 시스템의 설계에 대해 작성한 바 있다.

다음을 보세요 완성된 장 이러한 유형의 기술 문서에 대해.

가이드 및 지침 문서

간단히 정의하면, 하나의 안내 출판물은 단계별 지침, 팁, 관련 개념을 제공합니다. 또한 문제 해결 정보, 관련 커뮤니티 링크, 관련 연구 링크를 포함할 수 있습니다.

에이 지침 문서 정부 문서는 대중에게 유용한 정보를 제공하기 위한 것으로, 예를 들어 기존 법률이나 규정에 따른 의무를 명확히 하는 역할을 합니다. 이 문서는 행정 규칙의 복잡한 법률 문구를 대중이 해당 규칙을 준수할 수 있도록 이해하기 쉽게 풀어 설명하려고 합니다.

다음을 보세요 전체 장 이러한 유형의 기술 문서에 대해.

안내서

간단히 정의하면, 핸드북은 개념적 정보(기본 이론, 원칙, 기초), 지침 정보(단계별 지침), 그리고 참고 정보(빠른 조회용 정보)를 포함하는 포괄적인 자료이다.

다음을 참조하세요 전체 장 이러한 유형의 기술 문서에 대해.

지침

간단히 정의하면, 지침은 물건을 만드는 방법, 작동시키는 방법, 수리하는 방법을 알려준다—고전적인 "how-to." 기술 문서 작성 학생들에게 "기술 중심의 사용자 안내서."

다음을 보세요 전체 장 이 유형의 기술 문서에 대해.

문헌 검토

간단히 정의하면, 문헌 고찰은 특정 연구 주제에 대해 알려진 내용을 요약하고, 연구 역사의 이정표를 서술하며, 현재 지식이 상충하는 부분을 지적하고, 아직 알려지지 않은 영역을 논의한다.

다음을 보세요 완성된 장 이 유형의 기술 문서에 대해.

1차 연구 보고서 (실험 보고서)

간단히 정의하면, 일차 연구 보고서는 실험실 또는 현장 연구의 결과와 해석을 제시한다. 실험실 보고서로 생각할 수 있지만, 그것보다 훨씬 더 많은 것이다.

다음을 보세요 완성된 장 이 유형의 기술 문서에 대해.

진행 보고서

간단히 정의하면, 진행 보고서는 감독자, 동료 또는 고객에게 일정 기간 동안 프로젝트의 진행 상황을 알려준다. 프로젝트는 어떤 것의 설계, 건설 또는 수리일 수 있고, 문제나 질문에 대한 연구나 조사일 수 있으며, 기술적인 주제에 대한 정보 수집일 수도 있다.

그것을 보세요 완성된 장 이러한 유형의 기술 문서에 대해.

제안

간단히 정의하면, 제안은 누군가를 위해 특정 프로젝트를 수행하겠다는 제안이나 입찰이다. 제안을 제안으로 만드는 것은 그것이 청중에게 제안된 프로젝트를 수행하도록 승인하거나 자금을 지원하거나 허가를 내줄 것을 요청한다는 점이다.

다음을 참조하세요 완성된 장 이러한 유형의 기술 문서에 대해.

권고, 타당성, 평가 보고서

보세요 완성된 장 이러한 유형의 기술 문서에 대해.

표준 운영 정책 및 절차

이들은 조직을 위한 운영 문서들입니다; 조직과 그 구성원들이 어떻게 업무를 수행해야 하는지에 대한 규칙과 규정을 포함하고 있습니다. 정책과 절차는 지침과 같지만, 훨씬 더 광범위합니다. 표준 운영 절차(SOP)는 과정을 실제로 수행하는 절차에 더 해당합니다—예를 들어, 치아 인상 채취.

다음을 참조하세요 완성된 장 이러한 유형의 기술 문서에 대해.

기술 서적 출판

곧 공개됩니다...

그걸 보세요 장 전체 이 유형의 기술 문서에 대해.

기술 지향적 사용자 가이드

간단히 정의하면, 컴퓨터 사용자 가이드는 컴퓨터 하드웨어 또는 소프트웨어를 사용하는 방법에 대한 기술 정보를 제공하며, 설치, 구성 및 기타 필수 작업에 대한 지침을 포함합니다.

보세요 전체 장 이 유형의 기술 문서에 대해.

백서

간단히 정의하면, 백서는 프로젝트(장치, 방법 등)에 대한 배경을 제공하고 그것을 옹호하는 기술 또는 비즈니스 문서이다. 백서는 특히 많은 잠재 고객이 웹에서 정보를 검색하기 때문에 기업들에게 인터넷 상에서 인기 있는 마케팅 도구가 되었다. 기업들은 백서를 고객의 필요를 충족시킬 솔루션으로서 정보나 신제품을 판매하기 위해 사용한다.