문서화 자동화¶

다음 API 코드를 분석해서 상세한 API 문서를 작성해주세요:

[API 코드 첨부]

포함할 내용:
1. 엔드포인트 개요
2. 요청/응답 스키마
3. 인증 방법
4. 에러 코드 설명
5. 실제 사용 예시 (curl, JavaScript, Python)
6. 제한사항 및 주의사항

형식: OpenAPI 3.0 스펙 준수

Express.js 라우터에서 OpenAPI 스펙을 자동 생성하는 코드를 만들어주세요.

요구사항:
- JSDoc 주석에서 스펙 추출
- 자동 타입 검증
- Swagger UI 통합
- 실시간 문서 업데이트

기술 스택: Express, swagger-jsdoc, swagger-ui-express

다음 프로젝트를 분석해서 포괄적인 README.md를 작성해주세요:

프로젝트 정보:
- 저장소: [GitHub URL]
- 주요 파일: package.json, src/ 구조
- 기술 스택: [사용 중인 기술들]

생성할 섹션:
1. 프로젝트 개요 (목적, 주요 기능)
2. 설치 및 실행 방법
3. 사용법 (코드 예시 포함)
4. API 참조 (있는 경우)
5. 기여 가이드라인
6. 라이센스 정보
7. 문제 해결 섹션

스타일: 개발자 친화적이고 전문적인 톤

GitHub Actions를 사용해서 README를 자동으로 업데이트하는 워크플로우를 만들어주세요.

자동 업데이트 항목:
- 최근 커밋 정보
- 패키지 버전
- 기여자 목록
- 통계 정보 (다운로드, 스타 수)
- 최신 릴리스 노트

기술: GitHub Actions, Node.js 스크립트

다음 함수들에 JSDoc 형식의 상세한 주석을 추가해주세요:

[코드 블록]

포함할 정보:
- 함수의 목적과 동작 설명
- 매개변수 타입과 설명
- 반환값 타입과 설명
- 사용 예시
- 발생 가능한 예외
- 관련 함수나 클래스 참조

코드의 의도와 비즈니스 로직도 설명해주세요.

TypeScript 클래스/모듈에 대한 포괄적인 문서를 생성해주세요:

[클래스/모듈 코드]

생성할 문서:
1. 클래스 개요 및 용도
2. 생성자 및 속성 설명
3. 메서드별 상세 설명
4. 사용 패턴 및 예시
5. 상속 관계 및 인터페이스
6. 주의사항 및 베스트 프랙티스

UML 다이어그램도 함께 제공해주세요.

사용자를 위한 기능 사용 가이드를 작성해주세요:

기능: [기능명]
대상 사용자: [초급/중급/고급]

가이드 구조:
1. 기능 개요
2. 사전 준비사항
3. 단계별 사용법 (스크린샷 포함)
4. 고급 활용법
5. 문제 해결 (FAQ)
6. 관련 기능 연결

작성 스타일: 친근하고 이해하기 쉬운 설명

신규 사용자를 위한 단계별 튜토리얼을 설계해주세요:

제품: [제품/서비스명]
목표: 30분 내에 핵심 기능 체험

튜토리얼 구성:
1. 계정 생성 및 설정
2. 첫 번째 프로젝트 만들기
3. 핵심 기능 3가지 체험
4. 결과 확인 및 공유
5. 다음 단계 안내

각 단계마다 성공 기준과 체크포인트를 포함해주세요.

기존 마크다운 파일들을 분석해서 MkDocs 사이트를 구성해주세요:

현재 문서 구조:
[폴더 구조 설명]

생성할 요소:
- mkdocs.yml 설정 파일
- 네비게이션 구조
- 테마 설정 (Material Design)
- 플러그인 추가 (검색, 다국어 등)
- GitHub Pages 배포 설정

Material for MkDocs의 고급 기능도 활용해주세요.

마크다운 문서들을 내용에 따라 자동으로 분류하고 
적절한 폴더 구조를 제안해주세요:

현재 문서들:
[문서 목록 및 간단한 설명]

분류 기준:
- 대상 독자 (개발자/사용자/관리자)
- 문서 유형 (가이드/참조/튜토리얼)
- 기술 수준 (초급/중급/고급)
- 주제 영역

제안 형식: 폴더 구조 + 파일명 규칙

Notion API를 사용해서 개발 문서를 자동으로 동기화하는 시스템을 만들어주세요:

동기화 대상:
- GitHub 이슈 → Notion 데이터베이스
- 코드 주석 → Notion 페이지
- 릴리스 노트 → Notion 블록

기능 요구사항:
- 양방향 동기화
- 충돌 해결 로직
- 자동 태그 분류
- 알림 기능

기술 스택: Node.js, Notion API, GitHub API

Confluence REST API를 사용해서 개발 문서를 자동으로 업로드하는 스크립트를 만들어주세요:

업로드 대상:
- 마크다운 파일들
- API 스펙 문서
- 릴리스 노트

변환 기능:
- 마크다운 → Confluence 스토리지 포맷
- 이미지 자동 업로드
- 링크 자동 변환
- 템플릿 적용

CI/CD 파이프라인에 통합 가능하도록 구성해주세요.

Git commit/push 시점에 문서를 자동으로 업데이트하는 시스템을 구성해주세요:

트리거 이벤트:
- 코드 변경 시 관련 문서 업데이트
- 새 파일 추가 시 문서 인덱스 갱신
- 함수 시그니처 변경 시 API 문서 업데이트

구현 방식:
- Pre-commit 훅으로 문서 검증
- Post-commit 훅으로 자동 생성
- CI/CD에서 최종 배포

사용 도구: Husky, lint-staged, GitHub Actions

AST(Abstract Syntax Tree)를 분석해서 코드 변경사항을 감지하고 
관련 문서를 자동으로 업데이트하는 도구를 만들어주세요:

감지 대상:
- 함수 시그니처 변경
- 클래스 구조 변경
- API 엔드포인트 추가/수정
- 환경 변수 변경

업데이트 범위:
- API 문서
- README 파일
- 코드 주석
- 사용자 가이드

기술: TypeScript Compiler API, JSDoc, AST 파서

문서의 품질을 자동으로 검사하는 시스템을 만들어주세요:

검사 항목:
1. 맞춤법 및 문법
2. 링크 유효성
3. 이미지 존재 여부
4. 코드 예시 실행 가능성
5. 번역 일관성

도구 통합:
- Vale (프로즈 린터)
- Alex (포용적 언어 검사)
- 링크 체커
- 코드 실행 테스트

CI/CD 파이프라인에 통합해서 품질 게이트 역할을 하도록 구성해주세요.

문서 사용 패턴을 분석하고 개선점을 찾는 시스템을 구축해주세요:

수집할 메트릭:
- 페이지 방문 통계
- 검색 키워드 분석
- 사용자 피드백
- 문서 업데이트 빈도

분석 결과:
- 인기 문서 vs 방치된 문서
- 개선이 필요한 섹션
- 누락된 콘텐츠 식별
- 사용자 여정 분석

시각화: 대시보드 및 주기적 리포트 생성

문서의 다국어 버전을 자동으로 생성하고 관리하는 시스템을 만들어주세요:

지원 언어: 한국어, 영어, 일본어, 중국어

번역 과정:
1. 원본 문서 변경 감지
2. AI 번역 (GPT-4/Claude 활용)
3. 기술 용어 일관성 검증
4. 번역 품질 검토
5. 다국어 사이트 배포

고려사항:
- 기술 용어 사전 관리
- 문화적 맥락 고려
- 이미지 내 텍스트 처리
- SEO 최적화

도구: i18n 프레임워크, 번역 API, 품질 검증 도구

AI 번역의 품질을 향상시키는 시스템을 설계해주세요:

품질 향상 방법:
1. 도메인별 용어집 구축
2. 번역 메모리 활용
3. 인간 검토자 워크플로우
4. 피드백 학습 시스템

검증 프로세스:
- 자동 품질 점수 계산
- 일관성 검사
- 원어민 리뷰 요청
- 사용자 피드백 수집

기술 스택: Translation API, 품질 평가 모델, 협업 도구

프로젝트 문서를 학습한 AI 어시스턴트를 만들어주세요:

기능:
- 자연어로 문서 검색
- 질문에 대한 정확한 답변
- 관련 문서 링크 제공
- 부족한 문서 식별

구현 방식:
- 문서 임베딩 생성
- 벡터 데이터베이스 구축
- RAG (Retrieval-Augmented Generation) 시스템
- 웹 인터페이스 제공

기술: OpenAI Embeddings, Pinecone/Weaviate, LangChain

개발자의 코드를 분석해서 자동으로 문서를 제안하는 
VS Code 확장 프로그램을 만들어주세요:

기능:
- 함수/클래스 분석 후 문서 템플릿 제공
- 실시간 문서 품질 검사
- 팀 문서화 스타일 학습
- 자동 TODO 생성

사용자 인터페이스:
- 코드 에디터 내 인라인 제안
- 사이드바 패널
- 명령 팔레트 통합
- 설정 페이지

VS Code Extension API를 활용해서 구현해주세요.

문서화 자동화의 투자 대비 효과를 측정하는 프레임워크를 만들어주세요:

비용 요소:
- 도구 도입 및 설정 시간
- 초기 학습 곡선
- 유지보수 비용

절약 효과:
- 문서 작성 시간 단축
- 업데이트 자동화
- 품질 일관성 향상
- 개발자 생산성 향상

측정 지표:
- 문서 작성 시간 (Before/After)
- 문서 품질 점수
- 개발자 만족도
- 사용자 피드백 개선

대시보드 형태로 시각화해서 정기적으로 리포트를 생성해주세요.

Express.js 라우터 파일들을 스캔해서 엔드포인트를 추출하는 스크립트를 만들어주세요:

- 라우터 파일 자동 발견
- HTTP 메서드 및 경로 추출
- 미들웨어 분석
- JSDoc 주석 파싱

추출한 정보를 바탕으로 OpenAPI 3.0 스펙을 생성해주세요:

- 스키마 정의 자동 생성
- 예시 요청/응답 생성
- 태그 및 카테고리 분류
- 보안 설정 포함

생성된 스펙으로 문서 사이트를 자동 배포하는 워크플로우를 구성해주세요:

- Swagger UI 통합
- GitHub Pages 배포
- 자동 업데이트 설정
- 커스텀 테마 적용

다음 기능을 가진 README 생성기를 만들어주세요:

1. 프로젝트 분석:
   - package.json 분석 (의존성, 스크립트)
   - 소스 코드 구조 파악
   - 설정 파일 검토
   - 테스트 커버리지 확인

2. 컨텐츠 생성:
   - 프로젝트 설명 생성
   - 설치 가이드 작성
   - 사용법 예시 생성
   - API 문서 링크 포함

3. 지속적 업데이트:
   - Git 훅 연동
   - CI/CD 파이프라인 통합
   - 변경사항 자동 반영

CLI 도구 형태로 구현하고 npm 패키지로 배포해주세요.

문서 품질 대시보드를 구축해주세요:

모니터링 지표:
- 문서 커버리지 (코드 대비 문서화 비율)
- 최신성 (마지막 업데이트 시간)
- 품질 점수 (맞춤법, 완성도)
- 사용자 피드백

기능:
- 실시간 데이터 수집
- 알림 시스템 (임계값 초과 시)
- 트렌드 분석
- 팀별 비교

기술 스택: React 대시보드, Node.js API, 데이터베이스