From 30447882f1e5ca6e3bff350933fbe4ed85ebaa12 Mon Sep 17 00:00:00 2001 From: toki Date: Fri, 29 May 2026 05:49:00 +0900 Subject: [PATCH] =?UTF-8?q?docs(readme-skill):=20=ED=95=9C=EA=B5=AD?= =?UTF-8?q?=EC=96=B4=20=EC=A4=91=EC=8B=AC=20=EC=9E=91=EC=84=B1=20=EA=B8=B0?= =?UTF-8?q?=EC=A4=80=EC=9D=84=20=EB=AA=85=EC=8B=9C=ED=95=9C=EB=8B=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- agent-ops/.version | 2 +- agent-ops/skills/common/create-readme/SKILL.md | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/agent-ops/.version b/agent-ops/.version index ccc213c..4a3a6e6 100644 --- a/agent-ops/.version +++ b/agent-ops/.version @@ -1 +1 @@ -1.1.84 +1.1.85 diff --git a/agent-ops/skills/common/create-readme/SKILL.md b/agent-ops/skills/common/create-readme/SKILL.md index 9a56647..2437a93 100644 --- a/agent-ops/skills/common/create-readme/SKILL.md +++ b/agent-ops/skills/common/create-readme/SKILL.md @@ -1,6 +1,6 @@ --- name: create-readme -version: 1.0.0 +version: 1.1.0 description: README 작성, README 생성, 프로젝트 설명 문서 작성 요청에 대해 사람이 읽기 쉽고 AI가 다음 작업에 바로 활용할 수 있는 표준형 README.md를 생성하는 공통 스킬 --- @@ -78,6 +78,9 @@ README는 프로젝트 특성에 맞게 필요한 섹션만 사용하되, 기본 - `agent-ops/`가 있으면 규칙, 로드맵, 스킬 문서를 참고 문서나 작업 맥락에 연결한다. - `agent-roadmap/current.md`가 있으면 README에 현재 작업 위치를 복사하지 말고, 로드맵을 확인할 문서 경로만 적는다. - README는 제품 소개 문서이면서 작업 진입점이다. 마케팅 문구보다 실행 가능한 정보와 프로젝트 경계를 우선한다. +- README의 자연어 설명은 한국어 중심으로 작성한다. +- 단, README, API, CLI, SDK, runtime, build, test, lint, deploy, workflow, migration, integration처럼 개발자가 흔히 쓰는 영어 표현과 제품명, 기술명, 패키지명, 명령, 경로, 코드 식별자는 자연스럽게 영어로 유지한다. +- 널리 쓰이는 기술 영어를 억지로 번역하지 말고, 사람과 AI가 함께 읽기 쉬운 표현을 우선한다. - 불확실한 내용은 단정하지 않고 `TODO` 또는 "확인 필요"로 남긴다. ## 먼저 확인할 것