태그: Documentation
3편
-
테크니컬 라이팅: 독자 페르소나, 피라미드 구조, README와 API 문서 작성법
독자 페르소나를 정하고 피라미드 구조로 결론부터 쓰는 방법, 튜토리얼과 레퍼런스의 구분, README 필수 섹션, 엔드포인트별 API 문서와 OpenAPI·JSDoc 활용, 코드 예제·다이어그램·에러 메시지 작성법을 예시와 함께 설명합니다.
-
Mintlify로 개발자 문서 사이트 만들기: docs.json, MDX 컴포넌트, OpenAPI 레퍼런스 자동 생성
Mintlify로 개발자 문서 사이트를 만들 때 docs.json 필수 필드와 mint.json에서 옮기는 방법, MDX 페이지 작성 시 주의점, OpenAPI·AsyncAPI 스펙으로 API 레퍼런스와 플레이그라운드를 자동 생성하는 흐름, 내비게이션·테마 설정을 다룹니다.
-
Storybook으로 컴포넌트 개발하기: Story 작성, Args·Actions, Decorators, Addons, 비주얼 테스트
Storybook으로 UI 컴포넌트를 개발하고 문서화하는 방법. 설치와 설정, Story 작성, Args와 Actions, Decorators, Parameters, Addons, Vue 통합, 비주얼 테스트를 예제로 정리합니다.