본문 바로가기

테크니컬 라이팅/WTD 컨퍼런스

WTD 애틀랜틱 2023 - 문서 작성자를 위한 OpenAPI

반응형

나름 시각화를 통해 설명을 시도한 것은 좋았으나 뒤로 가면서 OpenAPI에 대해 점점 더 알기 어렵게 설명하는 것이 아닌가 싶습니다. OpenAPI 문서화는 문서 작성자가 따로 없더라도 어느 정도 형식을 갖추어 만들 수 있기 때문에 문서 작성자에게는 기회가 될 수도 있지만 딱히 그렇지 않을 수도 있습니다. ChatGPT 같은 AI 글쓰기 도구를 활용하는 곳이 늘어난다면 그 자리는 더 줄어들 수 있구요.

 

 

API 설계 초기부터 문서 작성자가 참여해야 한다는 이야기도 있는데 도메인이나 기술을 제대로 알지 못하면 소용이 없습니다. 물론 계속해서 참석하면서 쌓아갈 수는 있지만요. 당장 뭔가 내가 기여해야 한다는 압박을 가질 필요는 없습니다.

 

OpenAPI 관련 도구들이 정리된 곳입니다. 꽤 많은 목록이 정리되어 있고 OpenAPI 버전별로 지원 상태를 표기하고 있습니다.

https://openapi.tools/

 

https://youtu.be/0uEmEWj5hs0?si=ormGjdRrm0d5-jEw

 

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

 

OpenAPI

 

www.flickr.com

 

728x90