AIGNE-io의 DocSmith: AI 기반 문서 생성 도구

DocSmith는 Aigne Framework를 기반으로 구축된 AI 기반 문서 생성 도구입니다.

DocSmith는 다음 기능을 제공하는 완벽한 문서 생성 시스템입니다:

• 📚 코드 저장소, 텍스트 파일 및 미디어 리소스에서 포괄적인 문서를 생성합니다.
• 🏗️ 체계적인 문서 구조와 문서 사이트를 구축합니다.
• 📝 작업 공간 콘텐츠를 지능적으로 분석하여 구조화된 문서를 생성합니다.
• 🔄 코드/프로젝트 콘텐츠를 읽기 쉬운 문서로 변환합니다.
• 🌍 다국어 지원 및 문서 현지화(localization)를 제공합니다.
• 🖼️ 문서 이미지의 자동 생성 및 업데이트 기능을 갖추고 있습니다.
• 📤 여러 플랫폼으로 원클릭 게시(publishing)가 가능합니다.

생성할 수 있는 유형:

• 기술 문서 (Technical documentation)
• 사용자 가이드 (User guides)
• API 레퍼런스 (API references)
• 튜토리얼 및 예제 (Tutorials and examples)
• 제품 문서 (Product documentation)

DocSmith는 작업 공간 콘텐츠를 자동으로 분석하여 다음을 추론합니다:

대상 독자 (Target audience) - 문서를 주로 참고하는 사람 (개발자, 운영자, 최종 사용자 등)
사용 사례 (Use cases) - 사용자가 문서를 참조하는 상황 (첫 접촉, 개발 통합, 문제 해결 등)
문서 초점 (Documentation focus) - 문서 유형 (사용자 가이드, API 레퍼런스, 빠른 시작(quick start), 아키텍처 개요(architecture overview) 등)

추론된 결과는 사용자에게 확인을 위해 제시되며, 만족할 때까지 여러 차례의 조정이 가능합니다.

문서 생성을 시작하기 전에 DocSmith는 계획된 문서 구조를 표시합니다:

• 전체 문서 수와 계층 구조 (hierarchy)
• 각 문서의 제목(Title), 설명(description) 및 소스 파일
• 빠른 탐색을 위한 명확한 이모지 지표

사용자는 다음 작업을 수행할 수 있습니다:

• 문서 삭제/추가
• 계층 구조 조정 (병합(merge), 분할(split), 부모-자식 관계 조정)
• 콘텐츠 범위 수정

실제 콘텐츠 생성은 사용자가 구조를 확인한 후에만 시작됩니다.

aigne-doc-smith/
├── aigne.yaml # Aigne framework 설정 파일
├── package.json # 프로젝트 의존성 및 메타데이터
...

npm install -g @aigne/cli

프로젝트 루트에서 직접 실행합니다:

cd my-project
aigne doc

최초 실행 시, Aigne CLI는 DocSmith를 자동으로 설치하고 대화형 문서 생성 프로세스를 시작합니다.

자동 초기화:

DocSmith는 다음 작업을 자동으로 수행합니다:

• 현재 프로젝트 감지
• .aigne/doc-smith/ 디렉토리에 작업 공간(workspace) 생성 - config.yaml 설정 파일 생성

대화 중 완료되는 과정:

DocSmith가 다음 과정을 안내합니다:

• 출력 언어 요청 (미지정 시)
• 프로젝트 콘텐츠 분석
• 사용자 의도 추론
• 문서 구조 계획
• 구조화된 Markdown 문서 생성

my-project/
├── .aigne/
│ └── doc-smith/ # DocSmith 작업 공간
...

문서 프로젝트를 소스 코드와 분리하려면 독립적인 작업 공간을 사용하세요:

# 독립 작업 공간 생성
mkdir my-docs
cd my-docs
...

독립 모드는 여러 데이터 소스 구성을 지원합니다:

# config.yaml
sources:
-"name": "main"
...

• 소스 코드 및 프로젝트 구조의 지능형 분석

• 사용자 의도 및 대상 독자층 자동 추론

• 구조화된 Markdown 문서 생성

• 문서 계층 구조 계획 및 확인 지원

• 문서 이미지 자동 생성

• 이미지 플레이스홀더 시스템 지원

• 배치 업데이트 및 이미지 편집

• 다중 이미지 생성 모델 지원

• 문서 현지화 및 번역

• 다국어 문서 구조 관리

• 다양한 언어 버전의 자동 동기화

• 여러 플랫폼으로 원클릭 게시

• 사용자 지정 게시 설정 지원

• 문서 사이트 구축 및 배포

pnpm install

프로젝트는 코드 린팅(linting) 및 포맷팅을 위해 Biome을 사용합니다:

# 코드 확인
pnpm run lint
# 자동 수정
...

에이전트 추가 또는 수정 방법:

• agents/ 디렉토리에 에이전트 생성 또는 수정 - aigne.yaml에 새 에이전트 등록
• 에이전트 프롬프트 및 설정 파일 작성

유틸리티 함수 확장 또는 최적화 방법:

• utils/ 디렉토리에 유틸리티 함수 추가 또는 수정 - ES 모듈 구문 사용 확인 (.mjs)

files) - 필요할 때 가져와서 사용

Aigne Framework - AI 에이전트 오케스트레이션 프레임워크
Node.js - 런타임 환경 (ES 모듈)
pnpm - 패키지 매니저
Biome - 코드 린팅 및 포맷팅
YAML - 설정 및 데이터 형식

• Node.js (v18 이상)와 pnpm이 설치되었는지 확인하세요.
• Git이 설치되었는지 확인하세요 (서브모듈 및 버전 관리를 위해).
• Anthropic API 키 또는 다른 LLM 제공업체 구성이 필요합니다.
• 이미지 생성 기능을 사용하려면 해당 API 키 구성이 필요합니다.

만약 이전에 구 버전(*.aigne/doc-smith/ 디렉터리 구조)을 사용했다면, 다음을 권장합니다:

• 새로운 워크스페이스 디렉터리를 만드세요.
• 문서를 다시 생성하세요.
• 이전 버전 데이터는 수동으로 새 워크스페이스 디렉터리 구조로 마이그레이션할 수 있습니다.

Current 버전: 0.9.11

문제나 제안 사항은 프로젝트에 이슈를 열어주세요.

Arcblock - [email protected]

GitHub: @blocklet

Elastic-2.0 라이선스