티스토리 뷰

개인적인 정리

va.gov는 재향군인회 정도로 번역할 수 있을 것 같네요. Liani Lye는 PM이고 Gretchen Maciolek는 UX 라이터입니다(이들 외에도 Amy Goldman과 Mike Chelen도 등장합니다). 아. 그런데 재향군인회 소속은 아니고 adhoc.team이라는 곳에서 서비스를 구축했나 보네요(주로 연방정부 쪽 프로젝트를 담당하는 듯합니다).

 

프로젝트 레퍼런스를 https://adhoc.team/programs/va-gov/ 에서 확인할 수 있습니다.

va.gov를 운영하기 위한 10여개의 팀과 많은 팀원들이 있었고 콘텐츠를 담당하는 테크니컬 라이터는 3명이 있었습니다(정확하게 합류 시점은 잘 모르겠습니다. 아마도 어느 정도 프로젝트가 진행된 이후에 참여한 듯합니다).
플랫폼을 효과적으로 운영하기 위해서는 많은 다양한 정보가 필요했습니다. 기존 팀에서 문서를 직접 만들기는 하지만 여러 가지 문제점을 가지고 있었습니다. 낮은 품질의 문서, 찾기 어려운 문서, 관리가 되지 못하는 문서 등의 문제였죠. 그래서 이 문제를 테크니컬 라이터들이 해결해주길 원했습니다(일종의 컨설팅 업무죠. 테크니컬 라이터가 이런 업무를 프로젝트 형태로 진행하는 건 처음 보는 것이라 설명이 잘 이해되지 않았습니다. 개인적인 정리라 자세한 내용은 영상을 참고하세요).

그들은 다음과 같은 목표를 정했습니다.
Make a docs hub that's a trusted source-of-truth for customers to learn about the team's product.

 

그리고 내부적인 테크니컬 라이터 사이에 공유할 목표도 정했습니다(대외적이지 않지만 실제로 하고 싶은).
Create a culture that collectively prioritized documentation.
Empower technologists to proactively author content.

 


가이드
가이드라인을 만든다고 처음부터 모두 따르지 않습니다.
사람들이 가이드라인을 따르도록 유도해야 합니다.
처음부터 프로세스를 복잡하게 만들지 말고 당장 필요한 지침을 먼저 인지할 수 있게 합니다.

서비스
내부 사용자가 피드백을 보내고 이를 개선합니다.
사용성과 검색 가능성을 평가하고 개선합니다.
문서가 완벽하지 않아도 불안해하지 않도록 합니다. 문서에 대해 모니터링하고 개선할 부분을 가이드해줍니다.

글쓰기 지원
- 린터 지원(스타일 가이드 체크, 영어권에서는 이미 많은 도구들이 있기 때문에 반영하는 것이 어렵지는 않을 듯합니다).
- 인테이크 프로세스 도입
- 템플릿 지원
- 문서 소유, 책임의 명확화
- 개발 제품 팀에 테크니컬 라이터 참여
- 문서 상태를 측정하고 이를 공유해 어떤 부분에 우선순위를 두고 집중할지 참조할 수 있음

Q&A

단일 소스 정책은 어떻게 했나요?
이미 같은 주제에 대한 여러 개의 문서가 외부에 노출되고 있었음
(아마 질문을 잘못 이해한 것이 아닌가 싶은데)
하여간 내부적으로 문서 작성 시 충돌되는 주제를 발견할 수 있도록 몇 가지 도구를 지원하고 있다.

 

영상

https://youtu.be/7I9HoJIb6IU

현장 스케치

https://flic.kr/p/2nnCuqD

 

Liani Lye (she/her) and Gretchen Maciolek - All together now: Turning technologists into documentarians

Explore writethedocs' photos on Flickr. writethedocs has uploaded 2645 photos to Flickr.

www.flickr.com

 

댓글
댓글쓰기 폼