Free-cat/ste100

ASD-STE100 간소화 기술 영어

STE는 통제 언어입니다: 53개의 작성 규칙과 각각 하나의 의미와 하나의 품사를 가진 약 900개의 승인된 단어로 구성된 사전이 있습니다. 목적은 영어 능력이 제한된 독자나 번역가가 각 문장을 오직 한 가지 방식으로만 이해할 수 있도록 하는 것입니다.

작업 선택

작업	사용자가 제공하는 내용	반환 결과
작성(Write)	메모, 사실, 개요 또는 요청	STE로 작성된 새 문서
검사(Check)	기존 문서	발견 사항 보고서. 재작성 없음.
편집(Edit)	기존 문서	STE로 작성된 문서 및 변경 요약

요청이 명확하지 않은 경우(예: "이 문서를 봐 주세요"), 검사(Check)를 수행하고 편집(Edit)을 제안합니다.

리소스

• references/rules.md — 예제와 함께 모든 53개 규칙을 포함합니다. 검사(Check) 또는 편집(Edit) 작업 시, 그리고 규칙이 확실하지 않을 때 읽으십시오.
• references/dictionary.md — 승인되지 않은 단어와 승인된 대체어, 품사 함정, 기술 명사 및 기술 동사 범주, 소프트웨어 텍스트 관련 섹션을 포함합니다. 모든 작업 시 읽으십시오. 대부분의 위반은 단어 선택에서 발생합니다.
• scripts/ste_check.py — 프로그램이 찾을 수 있는 위반 사항을 찾습니다. 실행하되 읽지 마십시오. Python 3 표준 라이브러리만 사용합니다. 하나의 파일을 읽고 발견 사항을 출력합니다. 파일을 변경하지 않으며 네트워크를 사용하지 않습니다.

python3 scripts/ste_check.py <file> [--type auto|procedure|description] [--terms terms.txt] [--json]

--terms는 각 줄에 하나의 기술 명사 또는 동사(예: press, torque)가 있는 파일을 사용합니다. 그러면 스크립트는 해당 단어를 보고하지 않습니다.

이 스크립트는 1차 검사입니다. 긴 복합어 명사, 잘못된 의미, 관사 누락, 일관성 없는 용어는 찾을 수 없습니다. 또한 일부 올바른 텍스트(형용사로 사용된 과거분사는 수동태처럼 보임)를 보고하기도 합니다. 각 발견 사항을 검토하십시오.

가장 많은 위반을 유발하는 규칙

1. 승인된 단어 (1.1–1.3). 사전에 있는 단어를 승인된 품사와 의미로 사용하십시오. Check와 test는 명사입니다("Do a check of…", "Make sure that…"). Close는 동사입니다("near"로 쓰십시오).
2. 기술 명사 및 동사 (1.5–1.13). 특정 분야의 단어는 사전 외부에서 가져옵니다: 부품, 도구, 재료, 소프트웨어 객체, 단위(명사) 및 drill, weld, click, deploy와 같은 특정 프로세스(동사)입니다. 하나의 사물에 대해 하나의 용어를 사용하십시오. 일반 동사(verify, perform, utilize)는 기술 동사가 될 수 없습니다.
3. 동사 형태 (3.1–3.5). 부정사, 명령법, 단순 현재, 단순 과거, 단순 미래 및 형용사로 사용된 과거분사. 완료 시제("has failed") 또는 진행형("is running") 그리고 기술 명사("bearing", "operating temperature")가 아닌 경우 -ing 형태는 사용하지 마십시오.
4. 조동사. CAN과 MUST만 사용하십시오. should, may, might, could, would, shall은 사용하지 마십시오.
5. 능동태 (3.6). 절차에서는 항상 능동태를 사용하십시오. 설명에서는 행위자가 알려지지 않았거나 중요하지 않은 경우에만 수동태가 허용됩니다.
6. 문장 길이 (5.1, 6.3). 절차: 20단어. 설명: 25단어. 코드, 단위가 포함된 숫자, 레이블 및 괄호 안의 텍스트는 각각 한 단어로 계산합니다.
7. 각 문장에 하나의 지시사항 (5.2–5.4). 명령을 작성하십시오. 두 개의 동작이 동시에 발생하는 경우에만 결합하십시오. 조건을 먼저 쓰고 쉼표를 찍으십시오.
8. 단어를 생략하지 마십시오 (4.2, 4.5). 관사와 "that"을 유지하십시오. 축약형은 사용하지 마십시오.
9. 복합 명사 (2.1). 최대 세 개의 명사. 더 긴 것은 "of", "for", "that" 또는 하이픈으로 나누십시오.
10. 안전 및 참고 사항 (7.1–7.3, 5.5). 경고 또는 주의는 명령이나 조건으로 시작하여 위험을 제시하고, 적용되는 단계 앞에 위치해야 합니다. 참고 사항은 정보만 제공합니다. 참고 사항에 지시사항이 포함된 경우, 단계로 만드십시오. 안전 텍스트는 동일한 동사 규칙을 따릅니다: "The threads can become damaged" 또는 "This can cause damage to the threads", "The threads can be damaged"가 아닙니다.
11. 단락 (6.4–6.6). 하나의 주제, 먼저 주제 문장, 최대 6문장. 세 개 이상의 병렬 항목에는 세로 목록을 사용하십시오 (4.3). 세미콜론은 사용하지 마십시오 (8.1).

단어뿐만 아니라 구문도 변경하십시오 (9.1). STE는 동의어 대체가 아닙니다.

STE 아님	부적절함 (단어 대체)	STE
The system should be allowed to cool down prior to commencing disassembly.	The system must be let to cool before start disassembly.	Let the system become cool. Then, disassemble the unit.
Having confirmed the valve is closed, proceed with removal of the pump.	After you made sure the valve is closed, continue with removal of the pump.	Make sure that the valve is closed. Then, remove the pump.
The cache may need to be cleared if stale data is displayed.	The cache must possibly be cleared if old data is shown.	If the page shows old data, clear the cache.

세 가지 작업 모두에 대한 원칙

정확성 최우선. STE는 어떻게 말하는지는 바꾸지만 무엇을 말하는지는 바꾸지 않습니다. 각 사실, 값, 공차, 조건 및 범위 제한을 유지하십시오. 출처에 포함되지 않은 단계, 경고 또는 값을 추가하지 마십시오. 가능한 차이점은 미결 질문으로 남기십시오.

침묵 속에서 추측하지 마십시오. 출처가 모호한 경우("check the oil" — 수준인지 상태인지?), 가장 가능성 있는 의미를 선택하고 해당 항목을 미결 질문으로 나열하십시오. 목록을 짧게 유지하십시오: 답변에 따라 텍스트가 변경되는 지점만 포함하십시오. 좋은 질문 세 개는 답변을 받습니다. 열 개는 그렇지 않습니다.

비산문 텍스트는 그대로 두십시오: 코드, 명령어, 경로, UI 레이블, 부품 번호, 표지판 텍스트, 인용 텍스트, 법적 텍스트.

'dictionary.md'에 없는 단어. 파일은 하위 집합이므로 대부분의 단어는 포함되지 않습니다. 다음 순서로 결정하고 "확인"을 위해 일반 단어 목록을 만들지 마십시오.

1. 승인되지 않은 표에 있습니까? 대체어를 사용하십시오.
2. 해당 분야의 사물이나 특정 프로세스를 지칭합니까? 기술 명사 또는 동사입니다. 일관되게 사용하십시오.
3. 승인된 것으로 알려진 더 간단한 단어(핵심 동사 목록 또는 STE 예제의 단어)가 있습니까? 그 단어를 사용하십시오.
4. 그렇지 않고 단어가 평범하고 여기서 하나의 명확한 의미를 가지는 경우, 그 단어를 사용하십시오. 잘못된 선택이 의미를 바꿀 수 있는 경우에만 단어를 표시하십시오.

대문자. 사전 파일은 표기법으로 승인된 단어를 대문자로 표시합니다. 문서 및 보고서 텍스트에서는 일반 대소문자로 작성하십시오("use MUST"가 아닌 "use must").

사용자를 위해 작성하는 모든 것도 STE를 따라야 합니다: 제안된 수정 사항, 변경 요약 및 참고 사항. 자체 위반 사항이 있는 수정 사항(예: "is usually done by deploying…")은 잘못된 것을 가르칩니다. 파일 이름은 제공하되 전체 파일 시스템 경로는 제공하지 마십시오.

주장. 문서가 인증되었거나 완전히 준수된다고 말하지 마십시오. STE 규칙에 따라 문서를 작성하거나 검사했다고 말하십시오. 사전 제한을 한 문장으로 한 번만 언급하십시오. 준수가 계약 요구 사항인 경우, 공식 사양서(asd-ste100.org에서 요청 시 무료 제공)를 보유한 STE 교육을 받은 사람의 검토를 권장하십시오.

워크플로: 작성(Write)

1. 각 부분을 절차(독자가 무언가를 수행함) 또는 설명(독자가 무언가를 배움)으로 식별하십시오. 제한 사항이 다릅니다.
2. 용어 목록을 만드십시오: 각 사물에 대해 하나의 기술 명사, 각 프로세스에 대해 하나의 동사. 사용자의 용어집이 있으면 그것을 사용하십시오.
3. 초안을 작성하십시오.
   • 절차: 번호가 매겨진 단계, 각각 하나의 명령, 조건은 먼저. 각 경고 또는 주의는 해당 단계 바로 앞에, 각 참고 사항은 해당 단계 뒤에 배치하십시오.
   • 설명: 짧은 단락, 먼저 주제 문장.
   • 제목: 짧은 명사구 또는 명령("Start the unit"), -ing 형태는 사용하지 마십시오.
4. scripts/ste_check.py를 실행하십시오. 발견 사항을 수정하십시오. 다시 실행하십시오. 남아 있는 각 발견 사항이 검토하고 수용한 것일 때까지 반복하십시오.
5. 스크립트가 찾을 수 없는 사항(복합 명사, 품사, 관사, 하나의 사물에 하나의 용어, 각 단계에 하나의 지시사항)에 대해 초안을 읽으십시오.
6. 문서를 전달하십시오. 문서 뒤에 답변(또는 규칙선 아래, 작성자 참고 사항으로 표시)에 다음을 제공하십시오:
   • 사전 외부의 기술 명사 및 동사(remove 또는 install와 같은 승인된 단어는 제외);
   • 미결 질문.

워크플로: 검사(Check)

1. references/rules.md 및 references/dictionary.md를 읽으십시오.
2. 문서에 대해 scripts/ste_check.py를 실행하십시오.
3. 발견 사항을 검토하고 잘못된 것을 폐기하십시오. 그런 다음 스크립트가 찾을 수 없는 사항(작성 단계 5)과 구조(경고 위치, 참고 사항 내 지시사항, 둘 이상의 동작이 있는 단계)에 대해 문서를 읽으십시오.
4. 다음 구조로 보고서를 작성하십시오. 실행 가능할 정도로 충분히 짧게 유지하십시오: 문제가 있는 각 문장에 대해 한 행, 여러 곳에서 반복되는 문제에 대해 한 행.

# STE 보고서: <파일 이름>

## 요약
<3-5문장: 텍스트 유형, 전반적 수준, 가장 먼저 수정해야 할 가장 중요한 세 가지 사항.>

| 규칙 | 주제 | 발견 사항 |
|---|---|---|
| 1.1 | 승인되지 않은 단어 | 12 |

## 발견 사항
| # | 위치 | 규칙 | 원본 텍스트 | 문제 | 제안된 STE 텍스트 |
|---|---|---|---|---|---|
| 1 | 2단계 | 3.6, 1.1 | "The cover should be removed" | 수동태. "should"는 승인되지 않음. | "Remove the cover." |

## 미결 질문
<있는 경우에만. 최대 5개.>

보고서 규칙:

• 각 행에 규칙 번호를 제공하십시오. 원본 텍스트를 정확히 인용하십시오.
• 각 행에 대한 수정 사항을 제공하고, 수정 사항이 규칙(길이, 동사 형태, 능동태, 승인된 단어)을 준수하는지 확인하십시오.
• 명사가 3개 이하인 제목을 긴 문장 또는 복합 명사로 보고하지 마십시오.
• 안전 지시의 수준이 부적절해 보이는 경우(예: 데이터 손실에 대한 경고), 행에 그 내용을 명시하십시오. WARNING은 부상, CAUTION은 손상 또는 데이터 손실에 사용합니다.
• 보고서 작성 방법(스크립트 횟수, 폐기한 잘못된 발견 사항, "제한" 섹션)을 포함하지 마십시오. 요약에서 사전 제한에 대한 한 문장이면 충분합니다.
• 사용자가 요청하지 않는 한 전체 문서를 재작성하지 마십시오.

워크플로: 편집(Edit)

1. 검사 1~3단계를 수행하십시오. 발견 사항은 작업 목록이며 최종 결과물이 아닙니다.
2. 문서를 다시 작성하십시오. 구조, 제목, 번호 및 모든 기술 내용을 유지하십시오. 긴 문장과 여러 동작이 있는 단계를 나누십시오. 각 경고 또는 주의를 해당 단계 앞 위치로 이동하십시오. 참고 사항의 지시사항을 단계나 안전 지시사항으로 변경하십시오.
3. 결과에 대해 scripts/ste_check.py를 실행하십시오. 수정하고 작성 단계 4와 같이 스크립트를 다시 실행하십시오.
4. 문서를 출처와 동일한 형식으로 전달하십시오. 그런 다음 간단한 변경 요약을 제공하십시오: 주요 변경 유형과 각각의 전후 예제, 구조나 진술 강도를 변경한 각 위치("should"에서 "must", 참고 사항에서 단계로), 그리고 미결 질문. 사용자가 전체 변경 로그를 요청하지 않는 한 변경된 각 문장을 나열하지 마십시오.