기술 문서 초안
코드는 끝났는데 문서 작성이 계속 뒤로 밀리고 있을 때
이 요청문을 복사해서 쓰세요
기술 문서를 마크다운으로 씁니다. 구성 1) 개요 — 무엇을 하는 기능인지 3문장 이내 2) 사전 준비 사항 3) 사용 방법 — 단계별 설명과 요청·응답 예시 4) 파라미터 — | 이름 | 타입 | 필수 | 설명 | 기본값 | 5) 에러·예외 — | 상황 | 응답·동작 | 대처 | 6) 자주 묻는 질문 2개 지켜야 할 것 · 이 기능을 처음 보는 사람이 위에서부터 따라 하다 막히지 않을 것. 사양을 아는 사람만 이해되는 문장을 쓰지 말 것 · 예시 코드와 파라미터 표가 어긋나지 않을 것. 표에 없는 필드가 예시에 등장하면 안 됨 · 예시 값은 명백한 더미(example, sample)로 쓸 것. 실제 키·토큰처럼 보이는 문자열을 만들지 말 것 · 파라미터·기본값·에러 코드·제한을 지어내지 말 것. 사양에 없으면 [스펙 확인 필요]로 표기하고 문서 끝에 확인 목록으로 모을 것 문서화 대상: [API·기능 이름과 설명] 기술 사양: [엔드포인트, 파라미터, 응답 형식 등 아는 것 모두] 읽을 사람: [예: 사내 개발자, 외부 파트너] 예시 코드 언어: [예: JavaScript, Python]
쓰는 순서
- 위 요청문을 복사하세요.
- [ ] 로 표시된 부분을 내 상황에 맞게 바꾸세요. 이 부분이 결과 품질을 가장 크게 좌우해요.
- 쓰는 AI 서비스에 붙여넣고 결과를 확인하세요.
- 한 번에 완성하려 하지 말고 "세 번째 문단만 짧게"처럼 부분 수정을 요청하세요.
회사 자료를 넣기 전에 보안 주의사항을 먼저 확인하세요.
개발/IT가 함께 쓰는 프롬프트
📮 구독하면 「직장인 AI 활용 체크리스트 10」 바로 보내드려요
이메일을 남기시면 오늘 바로 써먹는 체크리스트를 즉시 발송해 드려요. 이후엔 새 AI 활용법·기능 소식이 있을 때만, 스팸 없이 알려드립니다.