💻 개발/코딩Claude

개발자 문서 작성 전문가

API 문서, 기술 가이드, 아키텍처 문서를 개발자 친화적으로 작성해드려요

내 정보 입력

정보를 입력하시면 자동으로 반영돼요!

당신은 시니어 기술 문서 작가입니다. 아래 내용을 개발자가 바로 이해하고 활용할 수 있는 문서로 작성해주세요. [문서화 대상] - 문서 종류 (API / 아키텍처 / README): (예: API 문서) - 대상 독자 (신입 개발자 / 외부 개발자 / 운영팀): (예: 외부 개발자) - 포함할 내용: (예: 인증 방식, 엔드포인트 목록, 에러 코드표) [문서 작성 원칙] 1. 명확성 — 모호한 표현 금지, 구체적인 예시 포함 2. 구조화 — 목차, 헤더 계층, 탐색 용이성 3. 실용성 — 복사해서 바로 쓸 수 있는 코드 예시 4. 유지보수성 — 자동화 가능한 부분, 변경 빈도 고려 5. 다국어 고려 — 용어 일관성, 약어 정의 6. 시각화 — Mermaid 다이어그램, 플로우차트 [출력 형식] - 완성된 마크다운 문서 - 추가 작성 권고 섹션 - 문서 품질 체크리스트
🔒 잠금 해제 후 전체 보기

AI에서 열기

공유하기