Write the Docs Newsletter – September 2022

Newsletter를 읽고 나름 감상평(?)과 실무진으로서 경험담을 적어보고자 한다.

 

Collecting helpful user feedback

유저 피드백받는 거 정말 소중하고 도움되는 거 맞지만.. ㅜㅜ

막상 피드백이 오는 경우가 잘 없더라..ㅎ

 

개인적인 경험으로는 신입 개발자들 온보딩 절차로 문서 읽고 피드백 내게 하는 프로세스가 제일 좋은 것 같다.

새로 입사했을 때가 제일 fresh eye로 열정 가득하게(?) 집중해서 보는 시기이기도 하고 해서-

그때 받은 피드백들이 문서 고치고 quality improve 하는데 제일 도움된 듯.

 

Some have had good results with prefilled feedback options as a middle ground between open-ended text fields and limited one-click rating scales. For example, you might ask users to complete a sentence from a list of short answers, such as completing “This page is…” with options like “helpful,” “incomplete,” “confusing,” or “too long.” The prefilled answers provide more detailed information that’s still categorizable without burdening users. If desired, you can include options for sending detailed feedback or even creating tasks for doc team review.

 

호오.. 그냥 좋아요, 별로예요로만 피드백을 받으면-

디테일을 알 수가 없어서 부족한데..

prefilled answers를 제공하면 응답하는 사람의 부담감을 줄여줄 수 있어서 좋은 듯!

이 방법은 생각 못해봤다.

 

 

Improving communication about what’s in releases

어떤 신규 기능이 릴리스될지 테크니컬 라이터가 미리미리 알면 좋지만..ㅎ

생각보다 쉽지 않을때가 있다 ^.ㅠ

특히 PM이 있고, 기술 문서를 중요하게 생각하는 PM이라면..

테크니컬 라이터도 잘 챙김.

배포 일정에 맞춰 기술 문서가 나가게 스케줄 관리를 해주는데-

아마 이게 베스트이지 않을까 싶다.

 

하지만 작은 회사는 PM이 없는 경우도 있고 😥

(이게 꼭 나쁘다는 건 아니지만)

테크니컬 라이터가 직접 배포 일정을 알아서(?) 챙겨야 할 수도 있음..

프론트 개발자랑 밥먹다 우연히(?) 배포 일정이 당겨진걸 알고 후다닥.. 문서 작업을 한적도 있었다.

 

docs as code가 이런 맥락이 아닐까 싶은데-

뭔가 기능이 배포될 때 공식 기술 문서도 같이 배포돼야 한다는 공감대가 구성원 사이에 생기는게 중요하지 않을까 싶다.

그렇지 않으면? 주요 제품이고 배포된지 이미 한참 됐는데 가이드 문서는 아직인.. 경우도 있음 흙

 

그래서 이 논란(?)에 대해 개발 미팅을 다 들어가는게 좋다.

회사에 따라서는 미팅 들어오는 걸 허용하지 않는 조직도 있기 때문에

미팅이 많은게 꼭 나쁜게 아니다- 이런 의견도 있는데

흠.. 모르겠다.

개발 미팅은 말그대로 개발 미팅이라서

아직 기능이 배포되기 전이고 (앞으로 수정될 가능성도 높고)

개발 미팅에 나오는 모든 내용이 테크니컬 라이터가 알아야 할 필요는 없어서..

PM같이 누군가 중간 다리 역할을 해주는게 좋다고 생각하는데.

 

PM을 거치는 걸 별로 선호하지 않는 실무진 얘기를 들어보면

(PM도 PM 나름이고.. 사람이 하는 일이다보니)

중요한 안건인데 PM에서 놓치고 전달을 못하는 경우도 있다고 한다.

Is coding necessary to write good docs?

테크니컬 라이터가 코딩을 할 줄 알아야 하나 자주 나오는 질문인데 다들 No라고 하길래 흠..

나는 IT 소프트웨어쪽은 아는게 좋다고 생각함.

개발을 아예 모르면 테크니컬 라이터로 일하기 힘든 회사도 있고,

 

현실적으로 개발 경험이 있으면 서류 통과가 더 잘되는건 사실이다.

 

https://www.writethedocs.org/blog/newsletter-september-2022/

Write the Docs Newsletter – September 2022 — Write the Docs