How to 문서를 최신 상태로 유지하기 with Eigent

작동 방식

1. 문서화가 필요한 변경된 소스 파일, 브랜치, 풀 리퀘스트 또는 커밋을 공유하세요.
2. 영향을 받는 기능 이름, 설정 키, 명령어, 예제를 기존 문서에서 검색하도록 Eigent에 요청하세요.
3. 변경이 필요한 문서만 업데이트하세요 — 페이지 구조, 용어, 교차 링크, frontmatter를 유지하세요.
4. 형식 지정 및 문서 검사를 실행한 다음, 각 사용자 노출 주장 뒤에 있는 근거를 요약하도록 Eigent에 요청하세요.
5. 게시하기 전에 요약을 검토해 내부 정보나 아직 공개되지 않은 맥락이 공개 문서에 유출되지 않았는지 확인하세요.

더 시도해 볼 프롬프트

• 이 PR에서 변경된 동작을 참조하는 기존 문서 페이지는 무엇인가요?
• 이 변경이 업데이트가 필요한 공개 API 매개변수, 기본값 또는 CLI 플래그에 영향을 주나요?
• 기존 형식에 맞는 이번 릴리스의 변경 로그 항목을 작성하세요.
• 업데이트된 문서에서 소스 코드만으로는 검증할 수 없는 사용자 노출 주장들을 식별하세요.

사용 방법

문서화해야 하는 변경 사항부터 시작하세요 — 브랜치, PR 또는 커밋을 공유하세요. 무엇이든 초안을 작성하기 전에 기존 문서를 검색하도록 Eigent에 요청해, 새로운 콘텐츠를 중복해서 작성하는 대신 올바른 페이지를 업데이트하도록 하세요. 범위를 좁게 유지하세요: 전체 페이지 재작성보다 정확한 주석이나 예제 업데이트가 더 좋습니다. 이 과정을 반복 가능하게 만들려면 워크플로를 스킬로 저장하거나, 각 릴리스 후 일정에 따라 실행하도록 Eigent에 요청하세요.

예상 출력

사용자에게 보이는 변경 사항만을 반영한 업데이트된 문서 파일, 변경 및 검증 내용 요약, 그리고 신뢰할 수 있는 출처로 확인할 수 없어 사람의 검토가 필요한 주장 목록.

제한 사항

• Eigent는 명시적으로 제공하지 않는 한 비공개 고객 데이터, 아직 공개되지 않은 로드맵 항목, 내부 위키에 접근할 수 없습니다.
• 문서 정확성은 소스 코드 주석과 테스트 커버리지의 품질에 따라 달라집니다 — 문서화되지 않은 동작은 놓칠 수 있습니다.
• 매우 큰 문서 사이트는 전체 사이트보다 특정 섹션이나 기능 영역으로 검색 범위를 좁히는 것이 유리합니다.