스타일 가이드
간결하게 씁니다: 한 문장에 한 생각, 형용사 대신 숫자. 긴 대시 대신 앞뒤에 공백을 둔 하이픈을 쓰고, 세미콜론은 쓰지 않으며, 문단 끝에 마침표를 찍지 않습니다
텍스트는 보고하는 것이지 파는 것이 아닙니다. 모든 감정은 먼저 목록, 표, 숫자로 바뀝니다. 마케팅, 전문가 흉내, 친절한 어시스턴트처럼 들리는 페이지는 모든 사실이 맞더라도 실패한 페이지입니다
단순함이 먼저
이 규칙은 다른 모든 규칙보다 위에 있습니다
군더더기가 전혀 없어도 읽기 어려운 텍스트가 있습니다. 모든 문장이 사실이지만 하나의 빽빽한 논증으로 엮여 있어서, 독자는 그 전부를 한꺼번에 머릿속에 담아야 합니다
초보자용 페이지는 훑어 읽을 수 있게 씁니다. 플레이어용 페이지, 레벨 제작자를 위한 첫 페이지들, 빠른 시작, FAQ, 도움말, 각 섹션의 랜딩 페이지가 여기에 해당합니다. 레퍼런스 페이지와 SDK 페이지는 더 촘촘해도 되지만, 그 문장에도 같은 규칙이 적용됩니다
- 지금 독자에게 필요한 것만. 문장마다 먼저 묻습니다: 이 문장을 읽고 나면 독자가 다르게 행동할까? 아니라면 지우거나 상세 페이지로 옮깁니다. 예외적인 경우, 플랫폼별 주의 사항, 내부적인 이유, 사이트 자체의 동작 방식은 초보자용 페이지에 넣지 않습니다
- 한 문장에 한 생각. 콜론, "때문에", "그래서", "한편"으로 이어진 절의 사슬도, 괄호 안의 괄호도 쓰지 않습니다. 긴 문장 하나보다 짧은 문장 두 개가 낫습니다. 문단 안에서 한 문장을 한 줄에 따로 둘 수도 있습니다: 마지막 문장을 빼고는 끝에 마침표를 찍습니다. 중국어와 일본어에서는 한 줄에 따로 선 문장이 별도의 문단이며, 앞에 빈 줄을 둡니다
- 예외가 아니라 일반 규칙. 언제 어긋나는지 세 문장으로 설명하는 대신 "번호는 보통 일치합니다"라고 씁니다. 예외는 상세 페이지에 두고
자세히 - [[page]](중국어는更多:[[page]], 일본어는詳細:[[page]], 스페인어는Más - [[page]], 포르투갈어는Mais - [[page]], 프랑스어는Plus - [[page]]) 링크 뒤로 보냅니다 - 설명보다 내비게이션. 랜딩 페이지는 짧은 소개와 "이름 -> 링크" 표, 또는
다운로드할 수 있는 모든 것 - [[download]]같은 줄로 이루어집니다. 링크만 봐도 알 수 있다면 "무엇인가", "상태" 같은 설명 열은 필요 없습니다 - 동작 방식이 아니라 무엇이 중요한지 말하기. 메커니즘을 설명하는 대신 "이 숫자가 다른 모든 숫자보다 중요합니다"라는 문장과 링크를 씁니다
- 상태는 한 단어로.
개발 중,사용할 수 없음,현재 버전 - gv 1.0.0. "작성 시점 기준", "빨라도" 같은 표현은 쓰지 않습니다 - 약어는 처음 나오는 곳에서 풀어 쓰기. 예를 들어 열 이름
gv->게임 버전 - 독자에게 말을 걸기. 질문과 답도 괜찮습니다:
문서가 마음에 들지 않나요? 그렇다면 작성을 도울 수 있습니다....하고 싶을 수도 있습니다도 괜찮습니다 - 쉬운 말. 용어는 독자가 게임 UI에서 마주칠 때만 등장합니다. 그때는 게임이 보여 주는 그대로 백틱으로 감쌉니다
수정 전(맞지만 무거움):
번호는 서로를 따라가지 않습니다. `gv`, `sv` 두 번호는 한때 같은 값에서 시작했고 이제는 자유롭게 갈라질 수 있습니다: SDK 변경이 있어도 게임 버전을 올릴 필요가 없고, 게임 업데이트가 있어도 SDK 버전을 올릴 필요가 없습니다
수정 후:
버전 번호가 서로를 따라갈 필요는 없지만, 대부분의 경우 일치합니다.
버전은 함께 올리기도 하며, 공통 업데이트에는 같은 버전이 붙습니다
문장 부호
문장 부호는 그 언어의 규범을 따르되, 의도적인 예외가 두 가지 있습니다. 둘 다 필수입니다
긴 대시 없음. 엠 대시와 엔 대시는 아예 쓰지 않습니다. 대시가 필요한 곳에는 앞뒤에 공백을 둔 하이픈을 씁니다
수정 전: Bullet Hero — 게임이라기보다 애니메이션 플레이어
수정 후: Bullet Hero - 게임이라기보다 애니메이션 플레이어
중국어와 일본어는 어떤 대시도 쓰지 않습니다: ——도, —도, 공백을 둔 하이픈도 쓰지 않습니다. 대신 쉼표, 콜론 또는 새 문장을 씁니다(중국어는 ,, :, 일본어는 、, :)
수정 전: Bullet Hero——与其说是游戏,不如说是动画播放器
수정 후: Bullet Hero与其说是游戏,不如说是动画播放器
수정 전: Bullet Hero——ゲームというより、アニメーションのプレイヤー
수정 후: Bullet Heroはゲームというより、アニメーションのプレイヤー
문단 끝에 마침표 없음. 문단 안의 문장 사이 마침표는 그대로 둡니다. 문단의 마지막 문장, 목록 항목, 표 셀, 제목에는 마침표를 찍지 않습니다. 물음표와 느낌표는 그대로 둡니다
줄 바꿈에 주의. Markdown은(는) 사이에 빈 줄이 없는 줄들을 하나의 문단으로 합칩니다. 마침표 없는 줄 다음에 다른 줄이 오면 두 문장이 붙어 버립니다
그래서 영어, 러시아어, 스페인어, 포르투갈어, 프랑스어에서는 문단 안에서 다음 줄이 이어지는 줄은 모두 마침표로 끝납니다. 따로 서는 생각 앞에는 빈 줄을 둡니다
중국어와 일본어에서는 문단이 소스의 한 줄입니다. Markdown은(는) 문단 안의 줄 바꿈을 공백으로 바꾸는데, 그 공백이 중국어나 일본어 문장 사이에 나타나 검색을 방해합니다. 그래서 중국어와 일본어 텍스트는 손으로 줄을 바꾸지 않고, 한 줄에 따로 서야 하는 문장은 별도의 문단으로 둡니다. 따로 서는 생각마다 앞에 빈 줄을 둡니다
기타 부호:
- 콜론은 설명과 나열에 쓰는 기본 부호이므로 자유롭게 씁니다
- 세미콜론은 절대 쓰지 않습니다. 대신 마침표나 별도의 목록 항목을 씁니다. 중국어도
;기호를 쓰지 않습니다: 두 문장으로 나누거나,기호를 씁니다. 일본어도 마찬가지로 두 문장으로 나누거나、기호를 씁니다 - 느낌표는 드물게, 긴 글 하나에 많아야 한 번 씁니다
- 따옴표는 영어, 러시아어, 스페인어, 포르투갈어, 프랑스어에서 곧은
"quotes"만 쓰고,«»기호는 절대 쓰지 않습니다. 중국어는 전각“”, 일본어는「」기호를 쓰고, 한국어는 영어처럼 곧은 따옴표를 씁니다 - 괄호는 짧은 여담, 단서, 건조한 농담에 써도 됩니다
중국어와 일본어
위의 규칙은 예외 없이 모든 언어에 적용됩니다. 중국어에는 몇 가지가 더해집니다:
- 독자 호칭은
你이며,您같은 말은 쓰지 않습니다. 조언은建议, 저자의 의견은我이며,开发者,我们같은 말은 쓰지 않습니다 - 전각 문장 부호
,。:?!(), 따옴표“”. 코드, 파일 이름, 백틱 안의 모든 것은 ASCII 문장 부호를 유지합니다 - 한자와 라틴 문자 또는 숫자 사이에 공백을 두지 않습니다. 게임 자체가 이렇게 씁니다:
在Bullet Hero中,60帧 - 라틴 문자로 유지하는 것: 제품명과 형식 이름(
Bullet Hero,JSON,BPM), 파일 확장자, 키, 필드 이름 - 용어는
game/zh-glossary.md에서 가져옵니다. 모든 용어는 표기가 하나이고,strict표시가 된 행은 항상 따릅니다. UI 라벨은game/zh.yaml에 있는 해당 키의 값에서 인용합니다 - 콜아웃 제목은 建议, 提示, 须知, 警告, 注意입니다(
> [!tip] 建议)
일본어에는 다음이 더해집니다:
- です/ます체로 씁니다. 독자를 대명사로 부르지 않으며
あなた도 절대 쓰지 않습니다: 대명사 없이도 주어가 분명하도록 문장을 짭니다. 조언은〜することをおすすめします또는推奨, 저자의 의견은私이며,開発者,私たち같은 말은 쓰지 않습니다 - 전각 문장 부호
、。:?!(), 낫표「」. 인용 안의 인용은『』. 코드, 파일 이름, 백틱 안의 모든 것은 ASCII 문장 부호를 유지합니다 - 외래어는 가타카나로 쓰며, 끝의
ー도 유지합니다:インスペクター,レイヤー. 일본어판 Unity 에디터가 이렇게 씁니다 - 가나나 한자와 라틴 문자 또는 숫자 사이에 공백을 두지 않습니다. 게임 자체가 이렇게 씁니다:
Bullet Heroでは,60フレーム - 라틴 문자로 유지하는 것: 제품명과 형식 이름(
Bullet Hero,JSON,BPM), 파일 확장자, 키, 필드 이름 - 용어는
game/ja-glossary.md에서 가져옵니다. 모든 용어는 표기가 하나이고,strict표시가 된 행은 항상 따릅니다. UI 라벨은game/ja.yaml에 있는 해당 키의 값에서 인용합니다 - 문장 부호는 굵게 표시 바깥에 둡니다:
**太字**。本文형태로 쓰고,**太字。**本文형태는 절대 쓰지 않습니다. 두 번째 형태에서는 Markdown이(가)**기호를 닫지 못해 별표가 그대로 출력됩니다 - 콜아웃 제목은 推奨, ヒント, 補足, 警告, 注意입니다(
> [!tip] 推奨)
한국어는 다음 사항을 더합니다:
- 합니다체로 씁니다 (
-ㅂ니다/-습니다). 독자를 대명사로 부르지 않으며당신은 쓰지 않습니다. 권장은권장합니다, 저자의 의견은저이며개발자나저희는 쓰지 않습니다 - 문장 부호는 ASCII이고 단어는 띄어 씁니다. 영어와 같으므로 위의 대시, 마침표, 따옴표 규칙이 그대로 적용됩니다
- 외래어는 한국어판 Unity 에디터의 표기대로 한글로 씁니다:
레이어,인스펙터 - 라틴 문자 단어, 코드, 플레이스홀더 바로 뒤에 조사를 그냥 붙이지 않습니다. 문장은 그 끝소리를 알 수 없으므로
을(를),이(가)처럼 짝 형태로 쓰거나 문장을 바꿉니다 - 라틴 문자로 남기는 것: 제품명과 형식 이름(
Bullet Hero,JSON,BPM), 파일 확장자, 키, 필드 이름 - 용어는
game/ko-glossary.md를 따릅니다. 용어마다 표기는 하나이며,strict표시가 있는 행은 항상 지킵니다. UI 레이블은game/ko.yaml에 있는 해당 키의 값으로 인용합니다 - 굵게의 끝에 문장 부호나 코드가 있고 바로 뒤에 조사가 오면 굵게가 깨집니다:
**이름**을처럼 쓰고**"이름"**을처럼 쓰지 않습니다 - 콜아웃 제목은 권장, 팁, 참고, 경고, 주의입니다(
> [!tip] 권장)
스페인어는 다음 사항을 더합니다:
- 스페인과 라틴아메리카가 함께 읽는 하나의 텍스트, 중립적인 스페인어로 씁니다. 독자는 단수
tú형태로 부르며usted,vosotros,ustedes같은 말은 쓰지 않습니다. 조언은se recomienda또는conviene형태로 쓰고te recomendamos같은 말은 쓰지 않습니다. 저자의 의견은yo형태로 쓰고los desarrolladores,nosotros같은 말은 쓰지 않습니다 - 대서양 양쪽에서 똑같이 읽히는 어휘를 씁니다:
fichero대신archivo,ordenador,computadora대신equipo또는PC,celular대신teléfono또는móvil. 화면을 누를 때는hacer clic, 키를 누를 때는pulsar표현을 씁니다 - 독자의 성별에 따라 형태가 바뀌는 형용사는 쓰지 않습니다 (
listo/lista). 문장을 바꿔 피합니다 - 두 가지 예외는 스페인어 조판 규칙보다 우선합니다: raya 대시 대신 앞뒤에 공백을 둔 하이픈
-기호를 쓰고(삽입구와 대화문에서도 마찬가지),«»대신 곧은 따옴표를 씁니다. 문단, 목록 항목, 표 셀, 제목 끝에 마침표를 찍지 않습니다.;기호는 쓰지 않습니다 ¿…?,¡…!기호는 항상 두 부호를 모두 씁니다- 제목은 첫 글자만 대문자로 씁니다 (
## Cómo funciona el ajuste). Title Case는 쓰지 않습니다. 대문자도 강세 부호를 유지합니다(Á,É) - 번역하지 않고 남기는 것: 제품명과 형식 이름(
Bullet Hero,JSON,BPM), 파일 확장자, 키, 필드 이름 - 용어는
game/es-glossary.md를 따릅니다. 용어마다 표기는 하나이며,strict표시가 있는 행은 항상 지킵니다. UI 레이블은game/es.yaml에 있는 해당 키의 값으로 인용합니다 - 콜아웃 제목은 Recomendación, Consejo, Conviene saber, Advertencia, Precaución입니다(
> [!tip] Recomendación).자세히 - [[page]]링크는Más - [[page]]형태로 씁니다
포르투갈어는 다음 사항을 더합니다:
- 브라질 포르투갈어로 쓰며, 코드
pt형태에는 지역이 붙지 않습니다. 독자는você형태로 부르고 동사는 3인칭으로 쓰며tu,o senhor,vocês같은 말은 쓰지 않습니다. 조언은recomenda-se또는vale a pena형태로 쓰고recomendamos같은 말은 쓰지 않습니다. 저자의 의견은eu형태로 쓰고os desenvolvedores,nós같은 말은 쓰지 않습니다 - 유럽식이 아니라 브라질식 어휘를 씁니다:
ficheiro대신arquivo,ecrã대신tela,guardar대신salvar,rato대신mouse,telemóvel대신celular,transferir대신baixar. 진행형은estar+ 현재분사 형태로 쓰고(está carregando),estar a+ 부정사 형태는 쓰지 않습니다 - 독자의 성별에 따라 형태가 바뀌는 형용사는 쓰지 않습니다 (
pronto/pronta). 문장을 바꿔 피합니다 - 두 가지 예외는 포르투갈어 조판 규칙보다 우선합니다: travessão 대시 대신 앞뒤에 공백을 둔 하이픈
-기호를 쓰고,«»,“”대신 곧은 따옴표를 씁니다. 문단, 목록 항목, 표 셀, 제목 끝에 마침표를 찍지 않습니다.;기호는 쓰지 않습니다 - 제목은 첫 글자만 대문자로 씁니다 (
## Como funciona o encaixe). Title Case는 쓰지 않습니다. 대문자도 강세 부호를 유지합니다(É,Ã) - 번역하지 않고 남기는 것: 제품명과 형식 이름(
Bullet Hero,JSON,BPM), 파일 확장자, 키, 필드 이름 - 용어는
game/pt-glossary.md를 따릅니다. 용어마다 표기는 하나이며,strict표시가 있는 행은 항상 지킵니다. UI 레이블은game/pt.yaml에 있는 해당 키의 값으로 인용합니다 - 콜아웃 제목은 Recomendação, Dica, Vale saber, Aviso, Cuidado입니다(
> [!tip] Recomendação).자세히 - [[page]]링크는Mais - [[page]]형태로 씁니다
프랑스어는 다음 사항을 더합니다:
- 프랑스에서 쓰는 프랑스어로 쓰며, 벨기에, 스위스, 캐나다에서도 똑같이 읽힙니다. 독자는
tu형태로 부르며vous같은 말은 쓰지 않습니다. 조언은il vaut mieux또는mieux vaut형태로 쓰고nous te recommandons같은 말은 쓰지 않습니다. 저자의 의견은je형태로 쓰고les développeurs,nous같은 말은 쓰지 않습니다 - 프랑스어 소프트웨어의 어휘를 씁니다:
fichier,paramètres,enregistrer,souris,écran. 화면을 누를 때는cliquer, 키를 누를 때는appuyer sur표현을 씁니다 - 독자의 성별에 따라 형태가 바뀌는 형용사는 쓰지 않습니다 (
prêt/prête). 문장을 바꿔 피합니다 - 두 가지 예외는 프랑스어 조판 규칙보다 우선합니다: tiret 대시 대신 앞뒤에 공백을 둔 하이픈
-기호를 쓰고(삽입구에서도 마찬가지),«»대신 곧은 따옴표를, 아포스트로피는 곧은'기호를 씁니다. 문단, 목록 항목, 표 셀, 제목 끝에 마침표를 찍지 않습니다.;기호는 쓰지 않습니다 ?,!,:기호 앞에는 줄바꿈 없는 공백(U+00A0)을 둡니다. 숫자 뒤%기호 앞도 마찬가지이며, 일반 공백을 쓰거나 공백을 빼지 않습니다. 코드와 백틱 안의 내용은 그대로 둡니다- 제목은 첫 글자만 대문자로 씁니다 (
## Comment fonctionne l'aimantation). Title Case는 쓰지 않습니다. 대문자도 강세 부호를 유지합니다(É,À) - 번역하지 않고 남기는 것: 제품명과 형식 이름(
Bullet Hero,JSON,BPM), 파일 확장자, 키, 필드 이름 - 용어는
game/fr-glossary.md를 따릅니다. 용어마다 표기는 하나이며,strict표시가 있는 행은 항상 지킵니다. UI 레이블은game/fr.yaml에 있는 해당 키의 값으로 인용합니다 - 콜아웃 제목은 Recommandation, Conseil, Bon à savoir, Avertissement, Attention입니다(
> [!tip] Recommandation).자세히 - [[page]]링크는Plus - [[page]]형태로 씁니다
레이아웃
- 짧은 문단, 한 줄에서 세 줄
- 글머리 기호 목록은 항목이 셋 이상인 나열에 씁니다. 번호 목록은 단계와 선택지에만 씁니다
- 표는 세 가지 이상을 여러 속성으로 비교하는 곳마다 씁니다
- 기울임꼴(
*text*)은 용어, 제품명, 장르에 씁니다: musical bullet hell, Geometry Dash. 중국어와 일본어 글꼴에서는 기울임꼴을 믿을 수 없으므로, 이 언어들에서는 라틴 문자로 쓴 제품명에만 기울임꼴을 쓰고 강조는 굵게 합니다 - 굵게는 한 단어를 강조하거나 문단을 그 주제로 시작할 때 씁니다
- 백틱은 기술적인 모든 것에 씁니다: 파일, 필드, 형식, 값, 키, 명령
- 버전은 항상 접두사와 숫자를 함께, 백틱으로 씁니다:
gv 1.0.0,sv 1.1.0,fv 1.0.0,bv 1.0.0,mg 2. 접두사 없는1.0.0, "version 1.0.0", "SDK 1.0.0" 같은 표기는 절대 쓰지 않습니다.title,# H1안에서는 백틱이 동작하지 않으므로, 그곳에서는 일반 텍스트gv 1.0.0형태로 씁니다. 서드파티(Unity, NuGet 패키지)의 버전은 이 프로젝트의 것이 아니므로 원래 형태대로 씁니다 - 이모지 없음
콜아웃
한 가지 구체적인 목적을 가진 문단은 콜아웃이 됩니다. 콜아웃은 정확히 다섯 가지이며, 제목은 페이지의 언어로 씁니다:
| 콜아웃 | 영어 제목 | 러시아어 제목 | 중국어 제목 | 일본어 제목 | 한국어 제목 | 스페인어 제목 | 포르투갈어 제목 | 프랑스어 제목 | 여는 내용 |
|---|---|---|---|---|---|---|---|---|---|
> [!tip] Recommendation | Recommendation | Рекомендация | 建议 | 推奨 | 권장 | Recomendación | Recomendação | Recommandation | 이렇게 할 것 |
> [!tip] | Tip | Подсказка | 提示 | ヒント | 팁 | Consejo | Dica | Conseil | 지름길, 요령, 더 빠른 방법 |
> [!info] | Worth knowing | Интересно | 须知 | 補足 | 참고 | Conviene saber | Vale saber | Bon à savoir | 결정을 설명하는 맥락 |
> [!warning] | Warning | Предупреждение | 警告 | 警告 | 경고 | Advertencia | Aviso | Avertissement | 시간이나 품질을 잃게 됨 |
> [!caution] | Caution | Внимание | 注意 | 注意 | 주의 | Precaución | Cuidado | Attention | 작업을 날리거나 깨진 레벨을 내보내게 됨 |
콜아웃은 페이지당 많아야 두 개입니다. 세 번째부터는 강조로 읽히지 않기 때문입니다. 레퍼런스 페이지는 섹션마다 두 개까지 둘 수 있습니다. 아직 존재하지 않는 것에 대한 페이지는 상태를 알리는 > [!warning] 콜아웃으로 시작하며, 이 콜아웃은 한도에 포함되지 않습니다
어조
- 독자 호칭은 "you" (러시아어는 소문자 존칭 "вы", 중국어는
你, 스페인어는usted대신tú, 포르투갈어는você, 프랑스어는vous대신tu). 일본어는 독자를 대명사로 부르지 않으며あなた도 절대 쓰지 않습니다 - 프로젝트는 비인칭으로 말합니다. "the developers", "we" 같은 주어는 쓰지 않습니다. 조언은 "it is recommended"(러시아어 "рекомендуется", 중국어
建议, 일본어〜することをおすすめします또는推奨, 스페인어se recomienda또는conviene, 포르투갈어recomenda-se또는vale a pena, 프랑스어il vaut mieux또는mieux vaut)이고, 사실은 그 대상 자체가 주어가 됩니다: "게임에는 텍스처가 전혀 들어 있지 않습니다" - 저자의 의견이나 결정은 1인칭으로 씁니다: "I recommend"(러시아어 "я рекомендую", 중국어
我建议, 일본어私は〜をおすすめします). 게임은 한 사람이 만들기 때문에 여기서 "I" 표현은 정직합니다. 진짜 판단이나 결정에만 쓰고, 단순한 사실에는 쓰지 않습니다 notes/의 노트는 1인칭으로 써도 됩니다. 노트는 그 저자의 보고이기 때문입니다- 문서에는 역사가 없습니다. 문서 페이지는 지금 어떻게 동작하는지를 설명합니다. "예전에는 X였다"는 노트에 씁니다
- 더 낫다는 주장 금지. 비교는 독자가 더 빨리 이해하도록 도울 때만 허용됩니다
- 지식의 한계를 밝힙니다. "아마도", "아직 알려지지 않음". 잘못된 확신은 모르는 것보다 나쁩니다
- 모든 판단에는 이유가 따릅니다. 이유 없는 형용사는 결함입니다
- 형용사 대신 숫자. 초, 프레임, 메가바이트, 버전, 오브젝트 개수
- 아이러니는 건조하고 드물게, 괄호 속 짧은 여담으로. 레퍼런스 페이지에는 거의 없습니다
- 욕설은 쓰지 않습니다. 어떤 언어에서든, 거친 대체어도 마찬가지입니다
- 주소, 숫자, 사실은 절대 지어내지 않습니다. 출처가 없으면 알 수 없다고 씁니다
페이지 도입부
도입부는 답하는 것이지 예고하는 것이 아닙니다. 페이지를 설명하지 않고("X이(가) 무엇인지, Y이(가) 어떻게 동작하는지, Z이(가) 어디에 있는지"), 페이지가 존재하는 이유인 질문에 짧게 답합니다. 이런 도입부는 독자가 더 읽지 않더라도 그 자체로 쓸모가 있습니다
핵심은 첫 문단에 둡니다. 첫 문단은 목록, 검색, 링크 미리 보기에 쓰이는 설명이기도 합니다: 200자에서 잘리고, 링크나 서식이 없습니다. 답은 둘째, 셋째 문단으로 이어져도 됩니다
짧은 페이지는 나누지 않습니다. 내용이 적으면 도입부를 위에 별도 줄로 반복하지 않고 본문과 합칩니다
수정 전:
버그를 신고하거나 질문할 곳, 그리고 버그를 재현할 수 있도록 무엇을 써야 하는지
수정 후:
게임 버그는 releases의 이슈에, 질문은 Discord에 올립니다. 설정에 있는 버전 문자열과 버그에 이르는 단계를 첨부합니다
페이지 구조
# H1, 그리고 페이지의 질문에 답하는 도입부- 본문은 도입부를 반복하지 않고 세부 사항, 사례, 단계를 제시합니다
##섹션 하나에 한 주제: 주장, 그다음 메커니즘이나 단계, 그다음 결론- 어울리는 경우 마지막에 구체적인 조언이나 "다음에 읽을 것" 링크를 둡니다
- 마무리는 페이지를 다시 요약하지 않습니다
가이드 페이지는 읽는 데 2분에서 4분이 걸리며, 분량은 약 2000자에서 3500자입니다. 레퍼런스 페이지는 더 길어도 되지만, 각 섹션이 그 자체로 읽혀야 합니다
남의 글임을 드러내는 것
- 긴 대시, 문단 끝의 마침표, 세미콜론
- "단순한 X 수준이 아니라 하나의 Y 그 자체"
- 3단 수사: "더 빠르게, 더 싸게, 더 안정적으로"
- 빈 도입: "오늘날의 세계에서", "자, 본격적으로 알아봅시다", "잘 알려진 사실이지만"
- 이미 말한 것을 반복하는 마무리 문단
- 이유 없는 열광적인 형용사: "놀라운", "엄청난", "강력한 도구"
- 공손한 군더더기와 독자에게 하는 사과
- 의미가 아니라 리듬을 위해 쓴 대칭적인 문장
- 이 게임에 맞는지 아무도 확인하지 않은 일반적인 조언
수정 전과 후
도입 문단
수정 전:
오늘날 레벨 디자인의 세계에서 Bullet Hero 에디터는 특별한 자리를 차지합니다 — 단순한
도구가 아니라 하나의 생태계 그 자체입니다. 자, 그 이유를 함께 알아봅시다.
수정 후:
에디터는 시간의 한 구간에 존재하며 키프레임을 따라 움직이는 오브젝트로 레벨을 만듭니다. 아래에서는 에디터의 구성과 작업 순서를 설명합니다
판단
수정 전:
Blob 형식은 로딩 속도를 극적으로 높이고 작업 흐름의 생산성을 끌어올리는 놀라운 솔루션입니다.
수정 후:
`Blob` 형식은 `Json`보다 빠르게 로드되지만, 눈으로 읽을 수도 git에서 변경 사항을 비교할 수도 없습니다. 작업하는 동안에는 레벨을 `Json` 형식으로 두고, 공개하기 전에 `Blob` 형식으로 변환합니다
아직 존재하지 않는 것
수정 전:
공식 서버는 레벨을 전 세계와 공유할 수 있는 편리한 방법을 제공할 것입니다.
수정 후:
공식 서버는 아직 없습니다. 게임이 서버와 통신할 때 쓸 프로토콜은 아직 설계되지 않았으므로, 이 페이지는 이미 정해진 것만 설명합니다
풀 리퀘스트 전 체크리스트
- 페이지를 훑어 읽을 수 있습니다: 한 문장에 한 생각, 세부 사항은 페이지 아래쪽이나 별도 페이지에 있습니다
- 엠 대시와 엔 대시가 없습니다(중국어와 일본어는 대시 자체를 쓰지 않습니다)
- 문단, 목록 항목, 제목이 마침표로 끝나지 않습니다
- 붙어 버린 줄이 없습니다: 따로 서는 생각은 각자 별도 문단이거나 한 줄 안에서 마침표로 구분됩니다. 중국어나 일본어 문단은 소스의 한 줄입니다
- 세미콜론과 이모지가 없고, 느낌표는 많아야 하나입니다
- 욕설이 없습니다
- 쉼표, 콜론, 문장 호응이 규범을 따르고, 오타가 없습니다
- 모든 판단 옆에 이유가 있습니다
- 숫자, 필드 이름, 링크는 출처에서 가져왔습니다
docs/에는 "the developers", "we" 같은 표현이 없습니다: 조언은 비인칭이고, "I" 표현은 저자의 의견이나 결정에만 씁니다- 콜아웃은 많아야 두 개입니다
- H1 다음의 도입부가 페이지의 질문에 답하고(핵심은 처음 200자 안에), 페이지를 설명하지 않으며, 아래에서 반복되지 않습니다
- 마무리가 페이지를 다시 요약하지 않습니다