본문 바로가기

테크니컬 라이팅

WTD 프라하 2021 - 히치하이커를 위한 문서화 도구, 프로세스 가이드

Lukas Reussner는 2018년 대학을 졸업하고 Bosch.IO에서 테크니컬 라이터로 일하고 있습니다. 보쉬 자회사로 고객사의 IoT 프로젝트를 지원하는 조직이라고 합니다. 하드웨어 개발부터 비즈니스 모델 설계까지 다양한 분야의 서비스를 제공한다고 합니다.

 

WTD 프라하 2021 첫 세션이었던 이번 발표는 간단한 개념부터 시작해서 QFD(Quality Function Deployment) 기반의 멋진 도구까지 공개해주고 있습니다. 세션 앞부분에서 요구사항의 분류나 문서 도구를 소개할 때까지만 해도 그냥 이렇게 소개만 하면 처음 문서화 작업을 시작하는 이들에게도 아니면 뭔가 현재 프로세스를 바꾸고자 하는 이들에게도 만족스럽지 못할 것 같았는데 QFD 이야기로 넘어가면서 시트에 간단한 체크를 통해 적절한 도구와 방안을 추천해주는 것은 무척이나 놀라웠습니다.

Q&A 시간에 이거 그냥 라이선스 없이 배포하는 것이 맞냐는 확인을 할 정도로 깔끔한 도구였습니다. 보쉬 내에서 사용하는 도구인지는 모르겠으나 발표자 이야기로는 QFD에 대한 자신의 학습 경험을 시트 형태로 만들어낸 것이 아닌가 싶네요(구글에서 'QFD excel template'으로 검색하면 비슷한 시트를 찾아볼 수 있긴 합니다. QFD를 아는 분들은 익숙한 도구일뿐이고 그렇지 않은 경우 오~하고 놀라게 되는 뭐 그런)

 

공유한 구글 시트 링크는 아래와 같습니다(QR 코드를 찍으면 나오는 링크인데, QR 코드를 찍으면 폰에서 열어야 하니깐~ 그냥 링크를 공유했으면 하는 아쉬움이~~ 그리고 QR 코드에서 공유한 링크는 웹뷰어 전용이라 일부 텍스트가 보이지 않더군요). 하여간 아래 링크로 들어가서 그걸 수정하지 말고 사본을 만든 후에 필요에 맞게 수정하세요.

https://docs.google.com/spreadsheets/d/1PZmo9GfrIeW21iMKVsFradvRs_KOEnpUWIAnUa6yB7E/edit#gid=671508999

 

Documentation Tooling Hitchhiker (CC BY-SA 4.0)

Input Functional Tool Requirements,Functional Tool Requirements,Functional Tool Requirements Documentation Requirement Categories,Documentation Requirements,Relative Weight (%),Importance (1 - 10),Translation memory systems (TMS) interface,Terminology cons

docs.google.com

각 컬럼 제목 기울이기를 어떻게 했지 싶어 찾아보니 그냥 간단하게 "텍스트 회전" 기능을 사용한 것이었더군요. 텍스트 회전과 적절한 Row 높이 조절로 저런 화면을 만들었습니다.

각 개발도구와 기능에 대한 가중치를 임의로 부여한 것이기 때문에 여러 방안 중 하나일 뿐 절대적이지는 않습니다. 사실 문서화 도구를 원하는 도구로 선택할 수도 있지만 이미 정해져 있는 경우에는 그 안에서 어떻게 요구사항을 구현할까를 고민해야지 다른 도구를 선택하는 것은 쉽지 않습니다.

 

보쉬처럼 규모가 있는 기업이라면 다양한 도구를 필요에 맞게 선택해서 사용할 수 있을지 모르지만 그렇지 않다면 간단한 일은 아닙니다. 주어진 환경 내에서 알아서 해야 하는 경우가 많아서~~

 

요구사항에 대한 이야기를 하면서 접근성에 대해서는 ISO 82079를 참고하라고 언급합니다. 국내에서는 "사용설명서의 작성 ― 구조, 내용 및 표현 ― 제1부: 일반적인 원칙 및 상세 요구 사항(KS _ C_NEW_2014_1068)"으로 공개되어 있구요.

해당 문서는 2012년에 작성되었고 2019년에 개정판이 나왔습니다. 국내 표준은 아직 적용되지 않은 상태구요. 국내 표준과 국제 표준은 아래 링크를 참고하세요.

https://e-ks.kr/streamdocs/view/sd;streamdocsId=72059226530502180

https://webstore.iec.ch/publication/29075

https://twitter.com/writethedocs/status/1444956725724000265

728x90
반응형