n8n 문서 스타일 가이드

n8n 문서를 작성할 때 따라야 할 문체, 형식, GitBook 블록 사용 규칙을 설명합니다.

문체 # n8n은 Microsoft Writing Style Guide 를 사용합니다. 이 페이지에서는 n8n 문서에서 가장 중요한 요소를 강조하고, 여기에 자체 스타일 선택 사항을 추가로 설명합니다. 쉬운 언어 # 문서화하는 프로세스의 각 단계를 명확하게 설명합니다. 현재 시제를 사용합니다. 글은 최대한 간결하게 유지합니다. 이를 돕는 무료 브라우저 앱 두 가지가 있습니다: Hemingway 는 언어의 복잡도를 측정합니다. 목표로 삼을 학년 수준에 대한 고정된 규칙은 없지만, 읽기 학년 수준이 낮을수록 좋습니다. Lexi 는 Markdown 텍스트의 작성 복잡도를 측정하며, 여러 지표를 결합해 하나의 가독성 점수를 산출합니다. 이상적인 통합 가독성 점수인 60점을 최소 기준으로 여겨야 하며, 대부분의 페이지는 이보다 높은 점수를 받아야 합니다. 다음과 같은 흔한 패턴에 주의하고, 더 쉬운 표현을 사용합니다: Avoid Use instead utilize, leverage use in order to to functionality, capabilities features, what it does It's important to note that X X n8n provides a powerful, seamless way to... n8n lets you... 몇 가지 기본 원칙: 불필요한 말을 덜어냅니다. "It's important to note that"나 "Simply" 같은 도입부 표현을 없앱니다. 마케팅성 언어를 피합니다. "powerful", "robust", "seamless" 같은 표현을 쓰지 않습니다. 기능이 실제로 무엇을 하는지를 서술합니다. 모호한 수식어를 없앱니다. "very", "quite", "several" 같은 표현 대신 구체적인 수치를 제시합니다. 문장을 짧게 유지합니다. 30단어 미만으로, 한 문장에 한 가지 개념만 담습니다. 세미콜론이나 두 번째 "and"로 이어진 문장은 나눕니다. "There is" 대신 행동을 먼저 제시합니다. "There is a node that can schedule workflows"가 아니라 "To schedule a workflow, add a Schedule Trigger"처럼 씁니다. 어조와 인칭 # 독자에게 직접 말하듯이 씁니다. 능동태를 사용합니다. "the request is sent by n8n"이 아니라 "n8n sends the request"라고 씁니다. 독자를 "you"로 지칭합니다. "Users can add a node"가 아니라 "You can add a node"라고 씁니다. 1인칭을 피합니다. "I", "we", "our" 대신 n8n을 주어로 씁니다. "we recommend"가 아니라 "n8n recommends"라고 씁니다. 축약형을 사용합니다. "do not", "you will" 대신 "Don't", "you'll"을 씁니다. 포용적 언어 # 모두를 위해 씁니다. 성별을 알 수 없는 사람에게는 "they"를 사용합니다. "his setti