AI를 활용한 기술 문서 자동 생성 - n8n 워크플로우

마크다운 형식의 글머리 기호 목록입니다.
복잡한 n8n 워크플로우 템플릿을 구축하는 n8n 자동화 전문가
n8n 프로세스를 신속하게 문서화해야 하는 테크니컬 라이터
n8n 워크플로우 내에 직접 포함된 일관되고 표준화된 문서를 요구하는 팀
n8n 워크플로우에서 사용자 지정 코드와 AI를 결합하는 방법을 보여주는 고급 예시를 찾는 사용자

복잡한 n8n 워크플로우의 문서를 유지 관리하는 것은 시간이 많이 소요될 수 있습니다. 이 특화된 n8n 워크플로우는 대상 n8n 템플릿의 모든 요소에 대해 고품질의 구조화된 스티키 메모 생성을 자동화하여 이 문제를 해결합니다.

gpt-4o-mini의 강력한 기능을 활용하여 각 n8n 노드의 구성을 분석하고, 명확한 설명, 주요 파라미터 세부 정보 및 검증 팁을 작성합니다. 이 자동화는 대상 n8n 워크플로우 로드, JSON 파싱, 메모 생성, 체계적인 레이아웃(RTL) 계산, 그리고 문서화가 완료된 최종 n8n 워크플로우를 다시 디스크에 저장하는 전 과정을 처리합니다. 이는 문서화 노력을 확장하기 위한 핵심적인 n8n 도구입니다.

이 강력한 n8n 워크플로우의 단계별 분석입니다:

1. 트리거 및 컨텍스트 설정: When clicking ‘Execute workflow’ n8n 트리거를 사용하여 n8n 워크플로우를 시작합니다. 후속 Set n8n 노드(Your Workflow Description)는 AI에 문서화할 워크플로우에 대한 일반적인 컨텍스트를 제공합니다.


2. 워크플로우 로드: load workflow n8n 노드가 정의된 경로에서 대상 워크플로우 JSON 파일을 읽습니다.


3. 파싱 및 필터링: Parse Workflow n8n 노드(Code)는 입력 구조를 검증하고, 기존 stickyNote 노드를 필터링하여 문서화를 위한 실제 n8n 노드 배열을 생성합니다.


4. 전체 문서화: Overall Sticky Note (OpenAI) n8n 노드는 n8n 워크플로우 구조에 대한 요약을 받아 LLM을 사용하여 상위 수준의 개요 메모를 생성합니다. 이 내용은 최종 조립을 위해 준비됩니다.


5. 노드별 문서화: 필터링된 노드들은 Split Out Items을 통해 개별 항목으로 분할되고, 각 항목은 Node Sticky Notes (OpenAI) n8n 노드로 전달됩니다. 이 노드는 전문화된 프롬프트를 사용하여 해당 단일 n8n 노드의 JSON 구성을 분석하고 상세한 문서화 스티키 메모 초안을 생성합니다.


6. 레이아웃 계산: Layout Blocks RTL (Code) n8n 노드는 새로 생성된 스티키 메모 내용과 원본 n8n 노드 데이터를 받아 최적의 위치를 계산합니다. 이를 통해 스티키 메모가 해당 n8n 노드 아래에 읽기 쉬운 오른쪽에서 왼쪽(RTL) 레이아웃으로 배치되도록 보장하며, 원본 노드의 새 위치도 등록합니다.


7. 최종 조립: 모든 구성 요소—원본 워크플로우, 새 노드 위치, 전체 개요 스티키 메모 내용 및 개별 노드별 스티키 메모—가 Merge1, Merge2를 통해 병합됩니다. Assemble Workflow (Code) 노드는 이러한 부분들을 통합하여 기존 스티키 메모를 깔끔하게 제거하고 최종 문서화된 n8n 워크플로우 JSON에서 모든 요소의 위치를 정확하게 조정합니다.


8. 결과 저장: 최종 문서화된 n8n 워크플로우는 Save documented Workflow n8n 노드를 사용하여 새 JSON 파일로 저장됩니다.

설치 및 자격 증명 설정을 설명하는 마크다운 형식의 문자열입니다.

🚀 설치 가이드

1. n8n 워크플로우 가져오기: 제공된 JSON 코드를 복사하여 워크플로우 섹션(JSON에서 가져오기)을 통해 n8n 인스턴스로 가져옵니다.


2. OpenAI 자격 증명 설정: 이 n8n 워크플로우는 OpenAI 자격 증명 설정이 필요합니다.

1. 실행: 'Execute workflow'를 클릭하여 자동화를 실행하고 문서화된 출력을 생성합니다.

주요 노드를 나열하는 마크다운 형식의 문자열입니다.

When clicking ‘Execute workflow’ (수동 트리거)
기능: 전체 문서화 프로세스를 시작하는 수동 실행용 시작 n8n 트리거 역할을 합니다.
주요 구성: 간단한 n8n 트리거이므로 구성할 사항이 없습니다.

load workflow (Read/Write File)
기능: 문서화가 필요한 대상 n8n 워크플로우의 원시 JSON 파일을 로드합니다.
주요 구성: File Selector를 대상 워크플로우의 파일 경로로 업데이트해야 합니다.

Parse Workflow (Code)
기능: 다양한 JSON 래핑 형식을 처리하고, 기존 stickyNote n8n 노드 유형을 필터링하며, AI 처리를 위해 정리된 실제 노드 배열을 준비하는 사용자 지정 로직입니다.
주요 구성: 워크플로우 구조를 언래핑하고 노드 요약하는 JavaScript 로직을 포함합니다.

Overall Sticky Note (OpenAI)
기능: 상세한 테크니컬 라이터 시스템 프롬프트를 기반으로 n8n 워크플로우 전체의 상위 수준 문서를 gpt-4o-mini를 사용하여 생성합니다.
주요 구성: gpt-4o-mini 모델을 사용하며, 입력 컨텍스트로 워크플로우 요약 텍스트를 받습니다.

Node Sticky Notes (OpenAI)
기능: 각 n8n 노드를 반복 처리하며, 해당 노드의 목적, 입력/출력 및 주요 필드를 설명하는 구체적이고 기술적인 스티키 메모를 생성합니다.
주요 구성: gpt-4o-mini 모델을 사용하며, 특정 n8n 노드의 JSON 구조를 프롬프트로 제공합니다.

Layout Blocks RTL (Code)
기능: 모든 n8n 노드와 새로 생성된 스티키 메모의 최적 시각적 위치를 계산하는 복잡한 사용자 지정 코드 n8n 노드입니다. 시각적 구성을 유지하기 위해 캔버스에서 오른쪽에서 왼쪽(RTL)으로 정렬합니다.
주요 구성: 노드 및 스티키 메모의 치수(NODEW: 300, STICKYW: 380, GAPX, GAPY)에 대한 상수 파라미터를 정의합니다.

Assemble Workflow (Code)
기능: 이 n8n 워크플로우의 마지막 단계입니다. 대상 워크플로우 JSON을 재구성하여 전체 개요 스티키 메모를 삽입하고, 계산된 모든 노드 이동을 적용하며, 개별 n8n 노드별 스티키 메모를 삽입합니다.
주요 구성: 이동 사항 적용, 이전 스티키 메모 제거, 개요 메모를 맨 왼쪽으로 배치하는 로직을 포함합니다.

Save documented Workflow (Read/Write File)
기능: 문서화가 완료된 n8n 워크플로우 템플릿 JSON을 출력 파일 경로에 씁니다.
주요 구성: File Name이 새 워크플로우 파일의 출력 경로를 정의합니다.