Skip to content
Back to search

korean-report-skills

MarketplaceWorks with Claude CodeGitHubIncomplete

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/janghyun-bin--korean-report-skills/badge.svg)](/listings/janghyun-bin--korean-report-skills)

HTML

<a href="/listings/janghyun-bin--korean-report-skills"><img src="/api/listings/janghyun-bin--korean-report-skills/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

| 환경 | 권장 설치 방식 | 설치 식별자 | |---|---|---| | Claude Code | GitHub `marketplace` 플러그인 | `korean-report@korean-report-skills` | | Codex | GitHub `marketplace` 플러그인 | `korean-report@korean-report-skills` | | OpenCode | npm 플러그인 | `korean-report-skills` | | Cursor | npm 파일 복사 | `korean-report-skills` |

Claude Code

/plugin marketplace add JangHyun-bin/korean-report-skills
/plugin install korean-report@korean-report-skills

Codex

codex plugin marketplace add JangHyun-bin/korean-report-skills
codex plugin add korean-report@korean-report-skills

OpenCode

`opencode.json`의 `plugin` 배열에 npm 패키지를 등록합니다.

{
  "$schema": "https://opencode.ai/config.json",
  "plugin": ["korean-report-skills"]
}

OpenCode를 다시 시작하면 package의 `config` hook이 두 스킬의 경로를 추가합니다. 이 방식에는 별도의 `npm i -g`나 `npx` 복사가 필요하지 않습니다.

Cursor와 파일 복사 설치

`npx` 설치기는 Claude Code, Codex, Cursor의 스킬 디렉터리에 두 스킬을 복사합니다. OpenCode의 npm 플러그인 등록과는 다른 설치 방식입니다.

npx korean-report-skills                 # Claude Code · Codex · Cursor
npx korean-report-skills cursor          # Cursor만 선택
npx korean-report-skills --project       # 현재 프로젝트에 설치
npx korean-report-skills --remove        # 복사한 스킬 제거

설치 후 새 세션을 시작하고 스킬 목록에서 `korean-report-doc`과 `korean-report-style`을 확인합니다. 갱신, 제거, 프로젝트 설치, claude.ai 업로드 절차는 [INSTALL.md](INSTALL.md)에 정리되어 있습니다.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 18 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "name": "korean-report-skills",
  3. "owner": {
  4. "name": "JangHyun-bin",
  5. "url": "https://github.com/JangHyun-bin"
  6. },
  7. "metadata": {
  8. "description": "한국어 기술·사업 문서의 제작과 편집 품질을 관리하는 두 개의 스킬",
  9. "version": "1.20.1"
  10. },
  11. "plugins": [
  12. {
  13. "name": "korean-report",
  14. "source": "./plugins/korean-report",
  15. "description": "자립형 HTML과 선택적 PDF 산출물을 제작하는 korean-report-doc, 문체·프레이밍·정확성·편집 정합성을 검토하는 korean-report-style을 포함한다."
  16. }
  17. ]
  18. }
README.md · README · 291 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <img src="docs/assets/logo.svg" width="30" align="middle" alt=""> <b>korean-report-skills</b>
  2. [![tests](https://img.shields.io/badge/tests-564%20tests-3fb950)](../../actions)
  3. [![release](https://img.shields.io/badge/release-v1.20.1-0066cc)](../../releases)
  4. [![plugin](https://img.shields.io/badge/plugin-Claude%20Code%20%C2%B7%20Codex%20%C2%B7%20OpenCode-8957e5)](INSTALL.md)
  5. [![license](https://img.shields.io/badge/license-Apache--2.0-d29922)](LICENSE)
  6. # Claude가 쓴 글이 어딘가 이상할 때 <!-- style-exempt -->
  7. 내용은 올바르더라도 번역체, 모호한 수치, 들쭉날쭉한 페이지 배치가 남으면 문서는 아직
  8. 초안처럼 보입니다.
  9. `korean-report-style`은 문체와 근거를 다듬고, `korean-report-doc`은 그 내용을
  10. 일관된 `layout`으로 구성합니다. 이어서 HTML `typesetting`과 렌더 검사를 수행하고,
  11. 필요하면 PDF와 검수용 스크린샷까지 생성합니다.
  12. 여기서 `layout`은 페이지와 요소의 배치를, `typesetting`은 CSS·글꼴·수식을 반영해
  13. 최종 HTML을 만드는 처리 단계를 뜻합니다.
  14. 글만 다듬을 때는 `korean-report-style`을 사용합니다. HTML이나 PDF까지 필요할 때는
  15. `korean-report-doc`을 함께 사용합니다. Claude Code, Codex, Cursor, OpenCode에서
  16. 사용할 수 있습니다.
  17. <picture>
  18. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/banner-dark.png">
  19. <img src="docs/assets/banner-light.png" alt="paper 보고서와 deck 협의자료 — 스킬이 생성한 문서 세 장">
  20. </picture>
  21. ## 두 스킬의 역할
  22. | 스킬 | 맡는 일 | 결과 |
  23. |---|---|---|
  24. | `korean-report-style` | 문체, 프레이밍, 용어, 상태·근거 표기, 편집 후 정합성 검토 | 수정 원고와 lint 결과 |
  25. | `korean-report-doc` | 문서 구조, `paper`·`deck` 모드의 `layout`, 도해, 수식, HTML `typesetting`, 렌더 QA | 자립형 HTML과 선택적 PDF |
  26. 문체 스킬은 어미만 바꾸는 교정기가 아닙니다. 실측과 추정을 구분하고, 주장에 근거가
  27. 있는지 확인하며, 리스크와 대응이 함께 적혀 있는지도 살핍니다. 문서 스킬을 함께 쓰면
  28. 이 검토를 공통 디자인 시스템과 브라우저 렌더 검사까지 이어 갑니다.
  29. ## 사용 예
  30. 설치한 뒤에는 평소처럼 작업을 요청하면 됩니다.
  31. ```text
  32. 지난주 벤치 결과로 기술보고서를 작성해 줘.
  33. 이 문단을 외부 협력사에 전달할 보고 문체로 수정해 줘.
  34. 이 진행현황에서 미측정 수치와 근거가 없는 주장을 표시해 줘.
  35. 회의에서 검토할 쟁점과 결정 요청을 가로형 협의자료로 만들어 줘.
  36. ```
  37. 스킬 이름을 직접 적을 필요는 없습니다. 명시적으로 선택하려면 Codex에서는
  38. `$korean-report-doc`, Claude Code에서는 `/korean-report-doc`처럼 요청할 수 있습니다.
  39. 설명이나 요약만 요청하면 대화 안에서 답하고, 별도의 문서 파일은 만들지 않습니다.
  40. HTML이나 PDF처럼 완성된 산출물을 요청하면 문서 제작 절차를 시작합니다.
  41. ## 결과물
  42. 문서의 목적에 따라 `paper`와 `deck` 중 하나를 선택합니다.
  43. | 항목 | `paper` | `deck` |
  44. |---|---|---|
  45. | 잘 맞는 문서 | 기술보고, 벤치마크, 진행현황, 연구노트 | 회의자료, 아젠다, 협의자료, 의사결정 요청 |
  46. | 방향 | 세로 | 가로 |
  47. | 페이지 흐름 | 내용이 이어지는 연속 문서 | 한 섹션을 한 페이지에 배치 |
  48. 두 모드는 글자 크기와 페이지 구조, 인쇄 규칙이 다릅니다. 하나의 문서 안에서는
  49. 두 모드를 섞지 않습니다.
  50. 완성된 HTML은 CSS, 사용된 KaTeX CSS와 글꼴을 한 파일 안에 담습니다. 실행할 때
  51. 외부 자원을 요청하지 않으므로 네트워크가 없는 환경에서도 열고 인쇄할 수 있습니다.
  52. PDF는 이 HTML을 자동화 브라우저로 인쇄해 생성합니다.
  53. 아래 이미지는 같은 가상 원고를 브라우저 기본 스타일로 저장한 HTML과 `paper` 모드로
  54. `typesetting`한 결과를 나란히 보여 줍니다.
  55. <table>
  56. <tr>
  57. <th width="50%">브라우저 기본 스타일</th>
  58. <th width="50%">paper 모드 적용</th>
  59. </tr>
  60. <tr>
  61. <td><img src="docs/assets/ba_before.png" alt="브라우저 기본 스타일로 표시한 가상 문서"></td>
  62. <td><img src="docs/assets/ba_after.png" alt="paper 모드를 적용한 가상 문서"></td>
  63. </tr>
  64. </table>
  65. 문체 규칙은 표현뿐 아니라 수치의 상태, 주장과 한계, 의사결정 요청의 근거에도
  66. 적용됩니다.
  67. <img src="docs/assets/ba_after_body.png" alt="도해와 상태 배지가 포함된 가상 문서 본문" width="100%">
  68. 전후 원고와 규칙별 근거는 [examples/before_after.md](examples/before_after.md)에서 볼 수
  69. 있습니다. 예시에 등장하는 기업, 공정, 인물, 수치는 모두 가상입니다.
  70. ## 설치
  71. | 환경 | 권장 설치 방식 | 설치 식별자 |
  72. |---|---|---|
  73. | Claude Code | GitHub `marketplace` 플러그인 | `korean-report@korean-report-skills` |
  74. | Codex | GitHub `marketplace` 플러그인 | `korean-report@korean-report-skills` |
  75. | OpenCode | npm 플러그인 | `korean-report-skills` |
  76. | Cursor | npm 파일 복사 | `korean-report-skills` |
  77. ### Claude Code
  78. ```text
  79. /plugin marketplace add JangHyun-bin/korean-report-skills
  80. /plugin install korean-report@korean-report-skills
  81. ```
  82. ### Codex
  83. ```bash
  84. codex plugin marketplace add JangHyun-bin/korean-report-skills
  85. codex plugin add korean-report@korean-report-skills
  86. ```
  87. ### OpenCode
  88. `opencode.json`의 `plugin` 배열에 npm 패키지를 등록합니다.
  89. ```json
  90. {
  91. "$schema": "https://opencode.ai/config.json",
  92. "plugin": ["korean-report-skills"]
  93. }
  94. ```
  95. OpenCode를 다시 시작하면 package의 `config` hook이 두 스킬의 경로를 추가합니다.
  96. 이 방식에는 별도의 `npm i -g`나 `npx` 복사가 필요하지 않습니다.
  97. ### Cursor와 파일 복사 설치
  98. `npx` 설치기는 Claude Code, Codex, Cursor의 스킬 디렉터리에 두 스킬을 복사합니다.
  99. OpenCode의 npm 플러그인 등록과는 다른 설치 방식입니다.
  100. ```bash
  101. npx korean-report-skills # Claude Code · Codex · Cursor
  102. npx korean-report-skills cursor # Cursor만 선택
  103. npx korean-report-skills --project # 현재 프로젝트에 설치
  104. npx korean-report-skills --remove # 복사한 스킬 제거
  105. ```
  106. 설치 후 새 세션을 시작하고 스킬 목록에서 `korean-report-doc`과
  107. `korean-report-style`을 확인합니다. 갱신, 제거, 프로젝트 설치, claude.ai 업로드 절차는
  108. [INSTALL.md](INSTALL.md)에 정리되어 있습니다.
  109. ## 문서 제작과 검수
  110. 문서 파일은 다음 순서로 만들어집니다.
  111. ```text
  112. 자료와 원고
  113. → Python 생성기와 문서 구조
  114. → 원시 HTML
  115. → Node와 KaTeX로 수식 렌더링, CSS 삽입, 자산 내장
  116. → 자립형 HTML
  117. → 브라우저 렌더 QA
  118. → 선택적 PDF와 검수용 스크린샷
  119. ```
  120. ### 문체 검사
  121. `korean-report-style`의 lint는 Markdown과 HTML의 가시 텍스트를 검사합니다.
  122. 치환 목록 134건과 제목, 문맥 의존 표현, 어미 규칙, 형태소 규칙, 서식 규칙을
  123. 여섯 갈래로 구분합니다.
  124. | 갈래 | 의미 |
  125. |---|---|
  126. | 고침 | 검증된 어미 활용형이며 `--fix`로 수정 가능 |
  127. | 검토 | 문맥을 확인한 뒤 선택해야 하는 표현 |
  128. | 제목 | 명사구가 아닌 제목 |
  129. | 의심 | `--heuristic`에서만 확인하는 문맥 의존 표현 |
  130. | 형태 | 형태소로 판정하는 어간·활용·어체 혼용 |
  131. | 서식 | 문장이 아니라 마크업의 결함 — 이모지, 라벨 목록, 제목 되풀이 |
  132. 검사 결과는 일반 텍스트뿐 아니라 JSON, GitHub annotation, SARIF로도 출력할 수 있습니다.
  133. 의미가 달라질 수 있는 용어나 문맥 의존 표현은 자동으로 수정하지 않습니다.
  134. ### 렌더 검사
  135. HTML을 브라우저로 렌더한 뒤에는 다음 항목을 확인합니다.
  136. - 수식 marker와 template token의 잔존 여부
  137. - 문서와 표의 가로 넘침
  138. - CSS token과 본문 글꼴 stack 적용
  139. - SVG `viewBox` clipping과 캡션 누락
  140. - `deck` section의 인쇄 페이지 초과
  141. 페이지 분할, 과도한 빈 공간, 제목의 고립, 다크 타일의 인쇄 반전처럼 수치만으로
  142. 판정하기 어려운 항목은 스크린샷과 PDF를 함께 확인합니다.
  143. ## 지원 범위와 현재 한계
  144. 문서 제작에는 진행현황, 중간보고, 기술보고, 연구노트, 벤치마크 보고, 협의자료,
  145. 회의 아젠다, 제안서가 포함됩니다. 문체 규칙은 코드베이스 인수인계, 아키텍처 문서,
  146. runbook, API reference, 모델 평가, 회의록, 컨소시엄 산출물에도 적용할 수 있습니다.
  147. 현재 범위는 다음과 같습니다.
  148. - 한국어 기술·사업 문서를 대상으로 합니다. 다른 언어의 문체와 `layout` 규칙은 아직
  149. 포함하지 않습니다.
  150. - 제공된 수치와 서술의 정합성은 검사하지만, 입력 자료에 없는 사실이나 근거를 새로
  151. 확정하지 않습니다.
  152. - 기준 결과물은 자립형 HTML이며, 필요하면 PDF를 함께 생성합니다. 네이티브 `.docx`와
  153. `.pptx` 파일은 생성하지 않습니다.
  154. - 법률·규제 적합성이나 외부 사실의 정확성을 보증하지 않습니다. 기한, 의무, 책임이
  155. 포함된 문장은 사용자가 제공한 근거 문서와 대조해야 합니다.
  156. 본문 글꼴은 동봉한 Pretendard 공식 subset(OFL 1.1)을 기본으로 HTML에 내장합니다. 다른 글꼴을
  157. 쓰려면 사용 권한이 있는 WOFF2 파일을 `--font`로 지정합니다. subset에 없는 한글 음절은 시스템
  158. 글꼴로 표시되며 빌드가 해당 글자를 알립니다.
  159. ## 필요한 실행 환경
  160. `korean-report-style`의 형태소 검사에는 `kiwipiepy`가 필요합니다. 없으면 검사기가 종료 코드 3(일부 검사 미수행)을 반환합니다.
  161. `korean-report-doc`으로 HTML을 빌드하려면 Node 20 이상과 KaTeX가 필요합니다.
  162. 렌더 QA, 스크린샷, PDF 출력에는 Python 3.11 이상, Playwright, Chromium이 필요합니다.
  163. ```bash
  164. npm install katex
  165. python3 -m pip install kiwipiepy playwright
  166. python3 -m playwright install chromium
  167. ```
  168. ## 소스 저장소에서 직접 실행
  169. 이 절은 설치된 플러그인의 사용법이 아니라, 저장소에서 생성기와 빌드 도구를 직접
  170. 실행하려는 개발자를 위한 안내입니다.
  171. 저장소의 Node 의존성은 `npm install`로 설치합니다. 위의 Python 실행 환경을 준비한 뒤
  172. 다음 명령으로 문서 뼈대를 만들 수 있습니다.
  173. ```bash
  174. npm install
  175. python3 scripts/new-document.py --title "문서 제목" --mode paper
  176. python3 문서_제목.py
  177. ```
  178. 생성된 Python 파일에서 본문, 표, 도해를 수정합니다. 다른 본문 글꼴을 쓰려면 실행할 때
  179. WOFF2 경로를 지정합니다.
  180. ```bash
  181. python3 문서_제목.py --font 다른글꼴-Regular.woff2 --font 다른글꼴-SemiBold.woff2
  182. python3 scripts/qa.py 문서_제목.html --pdf --shot shots/
  183. ```
  184. 문체 검사와 저장소 회귀 검사는 다음 명령으로 실행할 수 있습니다.
  185. ```bash
  186. python3 plugins/korean-report/skills/korean-report-style/assets/lint.py 초안.md
  187. python3 plugins/korean-report/skills/korean-report-style/assets/lint.py 초안.md --fix
  188. npm test
  189. ```
  190. ## 저장소 구조
  191. ```text
  192. plugins/korean-report/
  193. skills/
  194. korean-report-doc/
  195. assets/ template, CSS, figures.py, mathbuild.js, qa.py
  196. references/ design·figure 규칙
  197. korean-report-style/
  198. assets/lint.py 문체 검사기
  199. references/ 치환 규칙·software handoff heuristic
  200. .claude-plugin/ Claude Code·Codex marketplace 선언
  201. .opencode/ OpenCode npm plugin adapter
  202. bin/install.js Claude Code·Codex·Cursor file-copy 설치기
  203. scripts/ 생성기, QA, 패키징, 이미지 생성
  204. tests/ 정합성·회귀·end-to-end 검사
  205. ```
  206. 문체 규칙은 Markdown 표를 단일 원천으로 사용합니다. `base.css`에는 공통 디자인 token,
  207. `paper.css`와 `deck.css`에는 모드별 규칙이 있습니다. 도해의 SVG class도 같은 token을
  208. 사용합니다.
  209. 새 문체 규칙과 문맥 heuristic은 현재 구조 안에서 추가할 수 있습니다. 새 출력 모드,
  210. 글꼴 정책, 언어 지원을 추가하려면 template, builder, QA, 회귀 검사를 함께 변경해야
  211. 합니다.
  212. ## 기여와 보안
  213. 기여 절차와 회귀 검사 기준은 [CONTRIBUTING.md](CONTRIBUTING.md)에 있습니다. 보안
  214. 취약점은 공개 issue 대신 [Security Advisory](../../security/advisories/new)로 신고합니다.
  215. 세부 정책은 [SECURITY.md](SECURITY.md)에서 확인할 수 있습니다.
  216. ## 라이선스
  217. [Apache-2.0](LICENSE)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.