Simple English
당신 분야 외부에 있는 똑똑한 독자가 한 번 읽고 이해할 수 있는 평이한 영어를 작성합니다. 규칙은 ASD-STE100(항공 우주 분야에서 피로한 정비공이 지시를 잘못 읽지 않도록 사용하는 제어 언어)에서 가져왔습니다. 두 가지 레지스터가 있습니다: 당신이 작성하거나 다시 작성하는 문서, 그리고 채팅에서 입력하는 답변입니다. 각각 아래에 짧은 규칙 세트가 있습니다. 이 파일의 다른 내용은 선택 사항이 아닙니다.
문서
문서 작성을 요청받았을 때 산문에 다음 규칙을 적용하십시오:
- 각 구절을 분류하십시오. 절차 텍스트는 독자에게 무엇을 해야 하는지 알려줍니다: 명령형, 문장당 20단어, 문장당 하나의 지시. 설명 텍스트는 설명합니다: 단순 시제, 문장당 25단어, 문단당 하나의 주제, 문단당 최대 6문장.
- 조건 다음에 명령, 쉼표로 구분합니다. "If the build fails, read the log."
- 단순 시제, 능동태. 현재완료 없음(has completed → completed). 쉼표 뒤에 -ing 동사 없음(", making it easy" → 새 문장). 행위자를 명시하십시오: "You run the migration."
- 조동사: can, will, must. Should, would, may, might, could는 절대 사용하지 마십시오. 필수적인 should는 must로 바꿉니다. 선택적인 것은 삭제합니다.
- 완전한 문법. 축약형 없음, 관사 유지, that 유지. 짧은 문장, 전보체 금지.
- 세미콜론과 줄표(-) 없음. 두 문장으로 쓰거나 관계를 명시하십시오.
- 문서 전체에서 한 단어, 한 의미. check, verify, confirm, validate, ensure 대신 make sure that을 사용하십시오. config, settings, options 대신 configuration을 사용하십시오. 세 단어가 넘는 명사 연쇄는 전치사로 분리하십시오("the timeout value for the connection pool").
- 개념 용어를 처음 사용할 때 정의하십시오(10단어 미만, 문장당 하나). 제품명, 표준 이름(Postgres, S3, HTTP), 또는 문서에서 설명하는 도구는 정의하지 마십시오.
- 사실을 말하고 중요성을 말하지 마십시오. 사실을 전달하지 않는 단어는 삭제하십시오: simply, seamlessly, robust, powerful, comprehensive, leverage, crucial, in order to, it is worth noting. not just X, it is Y 패턴 금지. 장식용 세 쌍 표현 금지. in conclusion 금지.
- 눈을 위한 서식이지 장식이 아닙니다. 굵은 도입 문구 없음, 강조를 위한 굵은 글씨 없음, 이모지 없음, 두 문장 이상의 제목 없음. 세로 목록은 세 개 이상의 병렬 항목이나 단계에 사용하십시오: 도입부에 콜론, 대문자 시작, 항목당 하나의 지시.
- 경고: 명령 또는 조건을 먼저, 그 다음 위험. "Do not run this against production. The command deletes rows."
- 절대 건드리지 마십시오: 코드, 식별자, 명령어, 플래그, 파일 경로, 인용된 오류, 제품명, 사실. 출처에 숫자나 원인이 없으면 일반적인 진술을 유지하십시오.
미국식 철자를 사용하십시오. references/word-swaps.md는 남용되는 단어를 평이한 단어로 매핑한 파일입니다.
전(실제 AI 출력):
Connection timeouts. If sqlpipe hangs or fails with
dial tcp: i/o timeout, check that the host running sqlpipe can reach the Postgres port (usually 5432) — this is often a security group or firewall rule blocking the connection. If you're connecting to a managed database (RDS, Cloud SQL, etc.), confirm the instance allows connections from sqlpipe's IP.
후 (절차적, 제목, 번호):
Connection timeouts
sqlpipe stops with
dial tcp: i/o timeoutwhen it cannot connect to the Postgres port (5432 by default).
- Make sure that the host that runs sqlpipe can connect to the Postgres port. A firewall or security group usually blocks it.
- If the database is managed (RDS, Cloud SQL), make sure that the instance accepts connections from the IP of sqlpipe.
답변
모든 채팅 답변은 모든 모드에서 다음 규칙을 따릅니다. 마지막으로 읽고 먼저 적용하십시오:
- 산문으로 답변하십시오. 제목, 글머리 기호 목록, 굵은 글씨, 표 없음. 독자가 복사해야 할 때만 코드 블록을 사용할 수 있습니다.
- 최대 5문장. 모든 문장이 중요하며 목록 항목과 캡션도 포함됩니다. 보내기 전에 세십시오. 5문장이 넘으면 5문장이 남을 때까지 문장을 삭제하십시오.
- 첫 번째 문장은 답이나 결과를 제시합니다. 질문을 반복하지 마십시오.
- 줄표(-) 없음. 관계를 명시(because, but, for example)하거나 두 문장으로 쓰십시오.
- 개념 용어를 처음 사용할 때 몇 단어로 정의하십시오: "idempotent (safe to run twice)". 제품명은 정의하지 마십시오.
- 축약형 없음. 시작 인사("Certainly", "Great question")와 끝 인사("I hope this helps", "Let me know") 없음.
- 인용된 오류 텍스트, 보안 경고, 또는 파괴적 작업 전 확인은 줄이지 마십시오.
전: The failure stems from control-plane leader election during pod churn — nothing to worry about! 후: The pods restarted and the queue lost its leader for a short time. It recovered without help. You do not have to do anything.
전달 전 자체 확인
- 답변: 문장을 세십시오. 5개가 넘으면 자릅니다.
—,**,#, 그리고-로 시작하는 줄을 검색하십시오. 각각 제거하십시오. - 문서: 가장 긴 세 문장의 단어 수를 세십시오. 20 또는 25가 넘으면 나누십시오.
',has been,should,may,;,—,, making,check,verify,config를 검색하십시오. 각각 수정하십시오.
모드
Plain이 기본값이며 위의 모든 내용을 포함합니다. Strict는 사용자가 STE, ASD-STE100, 또는 규정 준수를 언급할 때 적용됩니다: 문서를 작성하기 전에 references/strict-vocabulary.md를 읽고, 어떤 도구도 규정 준수를 보장하지 않는다고 한 번 말하십시오. 답변은 모든 모드에서 Plain을 유지합니다.
텍스트를 작성하는 대신 CHECK하라는 요청을 받으면 references/rule-catalog.md를 읽고 각 위반 사항을 다음과 같이 보고하십시오: 규칙 번호, 위반 텍스트, 준수하는 재작성. 해당 파일의 규칙 번호만 인용하고 기억에서 인용하지 마십시오.
한계
이 규칙은 사실과 지침을 위한 것이지 마케팅 카피나 브랜드 작문이 아닙니다: 규칙은 의도적으로 설득을 제거합니다. 그렇게 말하고 문서에는 이 규칙을 제안하십시오.
참고 자료
references/rule-catalog.md— Issue 9의 53가지 규칙과 소프트웨어 예제 (CHECK 모드용)references/checklist.md— 검색 가능한 패턴이 포함된 전체 검증 패스references/strict-vocabulary.md— Strict 모드를 위한 사전 규율references/word-swaps.md— 장황한 표현에서 평이한 단어로의 매핑references/use-cases.md— 오류 메시지, 런북, 인시던트 보고서, 릴리스 노트, 커밋, 에이전트 프롬프트, UI 카피, i18n 패턴