개시하다

보조 엔지니어가 된 지 3년이 넘었는데 내레이션 활용(이하 내레이션)
이용자의 상담 대응 시간은 1∼20% 줄었다.
의외로 해설을 쓴 후 내버려두고 사용하지 않는 경우가 많다
1~2할의 지원 업무를 줄이기 위한 해설 활용 방법에 대한 실천을 써보고 싶다.
(업무류의 약간 복잡한 시스템을 구상했다.)

재활용성 시험

나는 프로그래밍을 할 때 같은 코드를 쓰지 않기 위해서는 재사용성을 중시해야 한다고 생각한다
내레이션이라면 같은 내용을 반복해서 쓰는 경우가 많다.
예를 들어 Qita의 해설을 바탕으로
아이콘 설정 방법과 암호 수정 방법이 각각 만들어진 문장을 가정합니다.
이 두 가지 모두 화면을 설정하는 기능입니다.
화면 오른쪽 위 아이콘 옆에 있는 드롭다운 탭을 클릭한 다음 설정을 클릭하여 설정 화면으로 이동합니다.
등 각자의 기사로 단조로운 순서를 소개해야 한다.
이렇게 반복되는 문장은 다른 해설사에서 제시하면 진전이 있을 것이다.
예를 들어 화면을 설정할 때까지의 과도법'이라는 해설을 만들어 캡처가 들어간 전환 방법을 설명한다.
그리고 각 보도에서 전환 방법은 문자가 아니라
'설정화면으로 이동.(참조 링크: http:///)'처럼'설정화면까지 이동하는 방법'의 글 링크로 변경됩니다.
가독성이 향상되고 UI가 변경되는 경우
화면이 설정될 때까지 마이그레이션 방법만 편집하면 되므로 변경을 준비합니다.
Qita는 간단하지만 업무 시스템 화면 전환이 복잡한 경우도 많아 재활용이 가능한 대표적인 예다.

메일 소개를 전제로 한 기사도 슬그머니 써냈다

해설은 사용자가 검색하고 스스로 해결하기 위한 것이다.이런 인상이 강렬하죠?
이런 주관적인 억단을 버리고 상담이 올 때 메일을 참고로 링크에 기재된 용도로 적극적으로 작성해야 한다고 본다.
예를 들어 제품 지원용 로그는 기본적으로 지원 요청이 없으면 얻을 수 없다.
따라서 순서도 우편으로 발송될 수밖에 없다.이럴 때 내레이션에 추가가 됐는지 고민이 돼요.
제품 지원으로 로그 획득 절차를 설명합니다.
해설을 하면 화면 캡처로 간단명료하게 소개할 수 있다.
메일의 본문에 긴 절차를 쓰면 가독성을 떨어뜨리고 지원자도 복제할 때마다 번거로움을 겪는다.
댓글 메일에 오류가 있는지 없는지도 최소한의 확인만 하면 된다.
그러나 이러한 설명은 지원 창에 마법사가 있는 경우에만 수행됩니다.
비교적 안전하다고 기재해 주세요.

반드시 검증해야 한다

해설에 착오가 있어서는 안 된다.'기억에 의존해서 기본적으로 문제 없겠지'라는 의식으로 해설을 쓰지 마세요.
불특정 다수 사용자의 눈이 닿는 것이기 때문에 해설 오류로 데이터가 부족해졌다.어쨌든 이것이 가장 중요하다.
반드시 검증을 해서 오류가 없는 방식으로 기재하는 것이 가장 효과적이다.

전제조건을 기재한 모형을 만들다

방백에 반드시 기재해야 하는 전제조건 등은 초기 형태로서 매번 방백의 첫머리에 써야 한다.
예:
소요 시간
- 영향 범위
- 대상 제품 버전
가끔 마지막에 나오는 해설이 있어요.
제품 버전과 소요 시간 등은 이 해설을 볼지 안 볼지 판단하는 중요한 정보이기 때문에 반드시 첫머리에 써야 한다.

명령과 조회의 집행도 정상적인 집행 결과에 맞추어 소개할 것이다

좀 번거롭지만 지령 집행이 끝나면 땡땡이 로그가 출력됩니다.이렇게
집행이 정상적으로 끝났음을 확인하는 방법도 함께 기재했다.
하면, 만약, 만약...
명령을 실행한 후 오류로 인해 정지되었지만, 오류 정보는 영어로 사용자에게 보입니다
일주일 동안 지령의 집행을 기다렸는데도 끝내지 못하면 슬프다.

글은 잠시 논하지 않는다.구분자로 구분하다

소설이 아니기 때문에 한마디가 짧다구분하다　
이것은 기술류 서적의 단문으로 내가 모방해 보았지만 읽기가 쉽다.
Qita에 접속해 화면 오른쪽 상단 아이콘 옆에 있는 드롭다운 탭을 클릭한 뒤 표시되는 설정을 클릭해 설정 화면으로 이동한다.
보다 더
"Qiita에 로그인합니다. 화면 오른쪽 상단 아이콘 옆에 있는 하단 옵션을 누르십시오. 표시되는 설정을 누르고 설정 화면으로 이동합니다."
읽기가 더 쉽잖아.

중복을 두려워하지 않다

기사가 늘어나면, 그거?이것과 비슷한 내용은 이전에 써 본 적이 없죠!?그런 걱정도 하고.
5분 정도면 쓸 수 있는 해설사라면 빨리 쓸 수 있다!같은 내용이라도 삽입구가 다르면 기사가 유용할 수 있고, 예전보다 지금의 자신이 더 좋은 해설을 쓸 수 있을 것 같다.

캡처 많이 쓰고요.

문장으로 순서를 설명하는 것이 아니라 캡처로 설명한다.
또한 Qita의 예는 "Qita에 로그인합니다. 화면 오른쪽 상단 아이콘 옆에 있는 드롭다운 옵션을 클릭하십시오. 표시되는 설정을 클릭하여 설정 화면으로 이동합니다."
캡처 한 장을 찍는 것이 한 장을 찍는 것보다 빠르고 이해하기 쉽다.

총화 해설을 하다

어느 정도 내레이션이 쌓이면 남들에게 보여주고 싶어 묻히는 내레이션도 생기고
"최소한의 설정으로 시작된 업그레이드 튜토리얼", "대시보드를 능숙하게 사용하는 방법"등
주제에 따라 링크를 수집하여 해설을 만들다.
총결산 해설은 통상보다 이해하기 쉬운 곳에 나타난다.

외국 편

target blank를 달다

글의 링크는 target=이어야 합니다.blank를 추가하고 새 탭에서 엽니다.
해설을 읽다가 나중에 보려고 링크를 클릭했을 때 화면이 이렇게 업데이트되면 절망감을 느낄 수 있다.

총결산

이상은 지원 효율성을 높이기 위한 해설의 활용법이다.
다시 생각나면 언제든지 업데이트하고 싶어요.