적절한 기술 세부 수준을 선택하려면 어떻게 해야 합니까?

시청자의 직업부터 시작하세요. 이해해야 하는 결정, 조치 또는 관계의 이름을 지정한 다음 해당 작업을 정확하게 수행하는 데 도움이 되는 용어 및 소스 세부 정보만 포함하십시오.

서면 매뉴얼 대신 다이어그램이나 이미지로 시작할 수 있나요?

네. 다이어그램, 장면 전환 또는 참조 이미지는 설명에 강력한 시각적 기반을 제공할 수 있습니다. 더 명확해져야 하는 관계, 움직임 또는 결정을 지정하는 요청을 추가하세요.

튜토리얼을 공유하기 전에 기술 소유자가 용어, 다이어그램, 안전 경계 및 버전별 세부 정보를 검토하도록 하세요.

하나의 질문, 답변을 뒷받침하는 소스, 계속 표시되어야 하는 순서 또는 결정 경계, 시청자가 다음에 취해야 할 조치를 작성하세요. 나레이션만으로는 숨길 수 있는 관계를 시각적으로 보여주도록 하세요.

차트, 매뉴얼, 설정 메모, 프로세스지도 및 기술 편지를 업로드하여 부분, 조건, 결정 및 시스템 관계를 시각화하는 튜토리얼을 생성합니다.

기계설명

이것을 시도해 보세요

“사용하기 @GenevaDrive, 는 연속 회전이 어떻게 정확한 인덱스 모션이 되는지 보여줍니다.”

기술 튜토리얼

이것을 시도해 보세요

“사용하기 MDN HTTP 개요, 에서는 클라이언트 설정부터 응답, 캐싱, 실패 경계까지 HTTP 요청 수명주기를 설명합니다.”

이탈리아어 원어민 쌤 위치: Blueprint Breakdown

이것을 시도해 보세요

“사용하기 @Atlas Scheduler v3 건축 및 출시 가이드, 출처를 개발자와 기술 커뮤니케이션을위한 명확한 블루 프린트 파괴 설명으로 변환합니다.”

복잡한 디자인도 따라하기 쉽게 해주세요

이것을 시도해 보세요

“사용하기 @BurjKhalifa, 은 Y자 계획, 지지 코어, 바람 후퇴 및 쌓인 매트를 보여줍니다.”

복잡한 장비도 쉽게 따라할 수 있도록 하세요

이것을 시도해 보세요

“사용하기 @리소그래피, 는 노출부터 패턴 전사까지의 전체 경로를 설명합니다.”

엔지니어링 및 기술팀
원래 사양을 작성하지 않은 사람이 이해할 수 있도록 시스템이나 프로세스가 필요합니다.
- 엔지니어
- 테크니컬라이터
전형적인 문서 :사양다이어그램
활성화 및 지원 팀
고객이나 팀원이 도움을 요청하기 전에 복잡한 설정이나 프로세스를 더 쉽게 재검토할 수 있기를 원합니다.
- 지원팀
- 지원팀
전형적인 문서 :설정 가이드프로세스 맵

당신의 문서를 준비하십시오

기술 다이어그램, 매뉴얼, 사양 또는 설정 노트를 튜토리얼 비디오로 전환하여 시스템과 프로세스를 더 쉽게 따라갈 수 있습니다.

집중된 경로

1
시청자의 질문 이름을 지정하세요.
시스템 질문, 시청자가 꼭 봐야 할 관계, 직업에 맞는 세부정보 수준을 명시하세요.
2
세부사항을 전달하는 소스를 가져오세요.
현재 소스를 추가하고 설명이 유지해야 하는 섹션, 용어, 그림 또는 단계의 이름을 지정합니다.
3
사용 맥락에 대한 설명을 구체화합니다.
튜토리얼을 공유하기 전에 기술 소유자가 용어, 다이어그램, 안전 경계 및 버전별 세부 정보를 검토하도록 하세요.

유용한 다음 단계