기존의 문서는 사용자가 어디서부터 시작을 해야 하는지 이게 무슨 기술을 설명하는지 명확하게 알 수가 없었습니다. 그래서 데니스는 팀에 합류한 후 기존 문서 읽기를 포기하고 직접 기술을 다루면서 개발자들과 이야기하기 시작했습니다. 그리고 자신이 이해한 내용을 일러스트를 포함한 내용으로 작성했습니다.
데니스는 2023년에 WTD 컨퍼런스에 참여해 배운 몇몇 개념들을 실제 문서화에 반영했다고 합니다. 일러스트도 그중 하나이구요. 발표를 듣고 영감을 얻은 내용은 발표자와 좀 더 깊은 이야기를 나누었습니다. 그리고 그 결과물을 문서화에 반영한 것이죠.
튜토리얼 샘플에 대해서는 뭐 길게 이야기했지만 샘플을 제공할 때 UI와 비즈니스 로직 부분을 분리하는 것이 좋다는 것입니다. 그렇게 하면 디자이너나 개발자 모두 자신이 필요한 것을 빠르게 접근해서 가져갈 수 있으니깐요.
문서 작업은 주로 구글 문서를 사용한다고 합니다. 개발자와 문서 내용을 공유하고 의견을 나누기가 수월하다는 장점을 가지고 있구요. 문서를 Markdown으로 변환하는 기능도 어느 정도 괜찮다고 하네요(물론 일부 수정 작업은 필요합니다).
ripple에서 문서화를 담당하지만 ripple 문서 사이트 쪽은 아니고 XRP LEDGER 문서화를 담당하는 것 같습니다. 두 개 문서 사이트의 스타일이 좀 다르긴 하네요.
https://xrpl.org/docs/introduction/what-is-the-xrp-ledger/
https://docs.ripple.com/payments-direct/introduction/concepts/payment-participants/
* WTD 컨퍼런스 리뷰를 올릴 때 우리말로 적절한 제목을 붙이고 있는데요. 이것도 여러 번 하다보니 소재가 점점 떨어지고 있네요. 이번 제목 같은 경우에는 2023년에 쓴 제목을 재탕했습니다 ㅠㅠ
2023.07.06 - [테크니컬 라이팅/WTD 컨퍼런스] - WTD 포틀랜드 2023 - 이미지를 적절하게 사용하기
https://youtu.be/Ss43qc7hdW8?si=Sw5lv40TQK4Y5aPe
이번 컨퍼런스의 스케치 노트는 대니스가 담당했다고 합니다. 그래서 자신의 발표는 어떻게 표현했을까 궁금했는데 아직 올라오지를 않았네요. 보통은 현장에서 작업을 하기 때문에 스케치 노트는 영상보다 더 먼저 올라오긴 하는데~~ 찾아보니 트위터 계정으로는 올라와있는데 플리커에는 아직 올리지 않았습니다. 아마 좀 손을 보고 색도 추가하고 하려는 모양입니다.
하여간 트위터에 올라온 스케치 노트는 여기~
https://twitter.com/writethedocs/status/1779918866274984360/photo/1
5/14 업데이트
스케치 노트가 업데이트됐습니다. 링크 추가합니다.
Dennis Dawson - Graphic Relief
www.flickr.com
