명령어 없이 작성 지침 설정
설치나 터미널 없이 아래 지침을 복사해 ChatGPT·Claude에 저장하세요. 보고서·문서 작성 요청에서 행안부 원칙을 적용하도록 안내합니다. 기존 지침에는 필요한 부분을 합치세요.
보고서·문서의 작성 또는 수정 요청에만 다음 지침을 적용한다. 코드·설정·일반 대화에는 적용하지 않는다.
[행정안전부 AI 친화적 보고서 작성 원칙]
- 표·그림 상단에 제목을 붙이고 번호 등으로 순서를 표시한다.
- 셀 병합은 단순하게 한다. 표 안의 표처럼 복잡한 양식은 피한다. 필요한 표를 일괄 삭제하거나 모든 병합을 금지하지 않는다.
- 문장은 서술식으로 작성한다.
- 항목 표시를 일관되게 쓴다. 단계가 필요하면 Ⅰ., 1., 가., 1), 가) 순서를 참고한다.
- 불필요한 시각적 꾸미기를 지양한다. 배치·장식만을 위한 표나 그림은 피한다.
[AI Doc Ready 자체 보완 지침]
- 주체·행위·조건을 명확하게 쓴다.
- 원문의 사실·수치·단위·날짜·고유명사·조건·주체·의미를 보존한다. 근거 없는 수치·계산 결과·인용·해석을 추가하지 않는다. 빠진 사실은 미제공으로 표시하거나 사용자에게 확인한다.
- 배경·근거·판단은 서술형, 독립 항목은 불릿, 순서가 중요한 절차는 번호 목록으로 쓴다. 여러 대상의 같은 속성이나 값을 비교할 때는 표를 유지한다. 한 문서에서 형식을 혼합할 수 있다.
- 작성 전 목적·독자·근거와 필요한 형식을 확인한다. 초안 작성 후 제목·순서 표시·병합·항목 단계·꾸미기를 점검하고 원문과 대조해 수정한다.
- 최종 문서와 검토 메모를 구분한다. 변경 이유와 확인되지 않은 사실·남은 수동 검토 사항을 필요한 경우 별도로 알린다.
- 파일·실행 도구를 사용할 수 있을 때만 aidocready 구조 검사를 추가한다. 실행하지 않았다면 검사했다고 말하지 않는다.
- 이 지침의 적용이나 구조 검사 통과를 사실 정확성 보증 또는 행안부 공식 인증으로 표현하지 않는다.ChatGPT에 저장하기
- 웹에서 설정 → 개인 설정 → 맞춤 지침을 엽니다. 앱에서는 사용 가능한 개인 설정 항목을 확인합니다.
- 복사한 지침을 기존 내용과 합쳐 저장합니다.
- 보고서 전용 프로젝트에서는 프로젝트 지침에도 같은 지침을 저장합니다.
Claude에 저장하기
- 설정의 Instructions for Claude(개인 지침)를 엽니다.
- 복사한 지침을 기존 내용과 합쳐 저장합니다.
- 보고서 전용 프로젝트에서는 Set project instructions에 붙여 넣고 Save instructions로 저장합니다.
계정 설정은 직접 저장합니다. 파일 첨부만으로 지침 설정을 대신하지 마세요. 메뉴는 서비스·앱 버전에 따라 다를 수 있습니다. 지침 적용은 공식 인증이나 사실 정확성 보증이 아니며, 모델 응답을 원문과 대조해야 합니다.
CLI로 지침 내보내기
터미널을 사용하는 경우 0.3.0부터 다음 명령으로 설정 안내와 지침을 확인할 수 있습니다.
npx aidocready@0.3.0 setup --target chatgpt
npx aidocready@0.3.0 setup --target claude
npx aidocready@0.3.0 setup --target chatgpt --output instructions.txt텍스트 파일에는 지침만 저장하며 기존 파일은 덮어쓰지 않습니다. --format json은 target, automaticSetup, setupSteps, instructions, sources를 포함합니다. 작성 지침은 고정 정책으로 --profile·--config와 함께 사용할 수 없습니다. 웹 대화에서 CLI를 실행하지 않았다면 검사 결과가 있는 것으로 해석하지 마세요.
처음에는 복잡한 표 세 사례의 변환·검사 비교를 확인하세요. 전체 변환·검사 결과에서 원본, Markdown과 검사 JSON을 내려받아 같은 검사를 재현할 수 있습니다.
첫 실행
Node.js 20 이상이 필요합니다. 위의 예제 파일을 내려받거나 검사할 Markdown/HWPX 문서를 준비하세요. 터미널에서 문서가 있는 디렉터리로 이동해 실행합니다.
npx aidocready@0.3.0 lint report.md
npx aidocready@0.3.0 lint report.hwpx --format jsonnpx의 첫 실행은 npm 레지스트리에서 패키지를 가져올 수 있습니다. 프로젝트에 설치해 버전을 고정하려면 다음을 사용하세요.
npm install --save-dev --save-exact aidocready@0.3.0
npx --no-install aidocready lint report.mdlint는 원본을 수정하지 않습니다. 출력된 진단을 확인하고 작업 사본을 수정한 뒤 다시 검사하세요.
여러 문서와 stdin
파일 여러 개 또는 디렉터리를 입력할 수 있습니다. 디렉터리는 Markdown/HWPX를 재귀 검사하고 발견한 파일을 정렬합니다. 디렉터리 안의 심볼릭 링크는 따라가지 않습니다.
npx aidocready@0.3.0 lint first.md second.hwpx --format json
npx aidocready@0.3.0 lint reports/ --format json --output result.json
cat report.md | npx aidocready@0.3.0 lint - --format jsonstdin 예시는 macOS/Linux 셸 기준입니다. Windows에서는 파일 경로 입력을 먼저 사용하세요. stdin은 UTF-8 Markdown만 받습니다. 다른 입력과 함께 사용할 수 없습니다. 일괄 결과는 results, errors, 합산 summary를 포함합니다. 일부 파일에 운영 오류가 있어도 읽을 수 있는 나머지 문서는 검사합니다.
출력 파일은 원본이나 설정 파일과 다른 경로를 사용하세요. 심볼릭 링크와 하드링크로 같은 파일을 가리키는 경우도 덮어쓰기를 차단합니다.
결과 읽기
| 진단 | 의미 | 다음 행동 |
|---|---|---|
| Error | 기본 프로파일에서는 자체 제목 구조 오류 | 제목 단계와 원본 구조 확인 |
| Warning | 제목·번호 등 인식된 구조의 개선 후보 | 원문과 규칙 근거를 보고 수정 여부 결정 |
| Suggestion | 복잡한 병합·캡션 위치 등 검토 후보 | 사람이 최종 판단 |
JSON 진단은 규칙 ID, origin, 위치, 원문 발췌와 도움말 링크를 제공합니다. origin=mois는 원칙의 근거가 공식 자료라는 뜻이며, 검사 문법과 심각도는 프로젝트가 정의한 운영 방식입니다.
| checks 상태 | 의미 |
|---|---|
| checked | 지원하는 구조에 정적 검사를 적용함 |
| not-applicable | 해당 검사 대상을 발견하지 못함 |
| unsupported | 일부 입력 구조를 지원하지 않아 판정 범위가 제한됨 |
| manual-review | 순서 표시·병합 등 사람이 판단할 항목이 있음 |
| disabled | 선택한 프로파일에서 해당 규칙을 끔 |
문제가 없다는 표시와 공식 원칙 전체를 확인했다는 뜻은 다릅니다. coverage.complete, coverage.manualReview, parserWarnings도 함께 읽으세요.
npx aidocready@0.3.0 rules MOIS-TABLE-CAPTION
npx aidocready@0.3.0 rules --format json사용자 프로파일
기본 recommended는 공식 원칙 기반 검사와 자체 보완 규칙을 함께 사용합니다. mois-core는 공식 원칙에 근거한 검사만 선택합니다.
npx aidocready@0.3.0 lint report.md --profile mois-core팀의 자체 정책을 적용하려면 프로파일 예제를 내려받아 규칙별 심각도 또는 off를 설정하세요.
{
"id": "team-report",
"extends": "recommended",
"rules": { "ADR-HEADING-LEVEL": "Warning" }
}npx aidocready@0.3.0 lint report.md --config profile.json알 수 없는 규칙 ID·심각도·속성은 거부합니다. 사용자 프로파일은 profileOrigin=aidocready로 구분합니다. 배포된 기본 프로파일 JSON은 규칙 메타데이터이며 사용자 설정 파일과 형식이 다릅니다.
가상 보고서의 열거형·서술형 작성 비교를 확인하세요. 실제 작성은 호스트 에이전트가 하고, AI Doc Ready SKILL은 작성 원칙을 안내하며 CLI는 구조를 검사합니다. CLI 자체의 자동 변환 기능은 아닙니다.
에이전트 연결
Codex·Claude Code·pi처럼 셸을 사용할 수 있는 에이전트에서 CLI를 호출합니다. 에이전트가 보고서를 작성하고, 정적 lint와 원문 대조 후 수정하도록 안내하세요.
npx aidocready@0.3.0 setup
npx aidocready@0.3.0 doctor --format jsonsetup은 설치 자산 위치와 적용 방법만 보여 줍니다. 에이전트에서 설정한 스킬 디렉터리에 SKILL.md를 복사하고, 기존 상시 지침에 필요한 부분을 합치세요.
- 제공된 근거에서 초안을 작성합니다.
lint --format json --fail-on Warning을 실행합니다.- 진단의 위치와 근거를 확인하고 원문과 대조합니다.
- 수치·조건·의미를 보존하며 수정한 뒤 다시 검사합니다.
스킬 설치가 모든 보고서에서 자동 실행을 보장하지는 않습니다. 에이전트의 상시 지침과 실제 호출 결과를 함께 확인하세요.
CI와 종료 코드
기본 실패 기준은 Error입니다. 경고까지 검토하도록 CI에 연결하려면 --fail-on Warning을 사용하세요.
npx aidocready@0.3.0 lint reports/ --fail-on Warning| 종료 코드 | 의미 |
|---|---|
| 0 | 선택한 실패 기준에 해당하는 진단이 없고, 지원 구조의 검사 누락이 없음 |
| 1 | 실패 기준에 해당하는 진단 또는 검사 누락이 있음 |
| 2 | 파일·옵션·프로파일·파싱 등 운영 오류가 있음 |
--fail-on Suggestion은 모든 진단에 실패합니다. 운영 오류는 기존 error.code=INPUT_ERROR와 구체적인 error.reason을 함께 반환하며, Kordoc의 원인 코드는 causeCode에 보존합니다.
라이브러리 API
TypeScript·JavaScript 프로젝트에서도 같은 검사 엔진을 사용할 수 있습니다.
import { lintFile, lintMarkdown, loadProfile } from "aidocready";
const result = await lintFile("report.hwpx");
const profile = await loadProfile("profile.json");
const draft = lintMarkdown("# 보고서\n\n본문이다.", profile);SDK 오류는 AidocreadyError.code로 분기합니다. 파일 입력에는 lintFile(path, profile, { maxBytes })로 더 작은 크기 한도를 적용할 수 있습니다.
지원 범위와 한계
- 1차 지원 형식은 Markdown(GFM)과 HWPX입니다.
- Markdown의 원시 HTML 구조는 미지원으로 표시합니다. 코드 블록은 검사에서 제외합니다.
- HWPX 쪽 번호는 Kordoc의 섹션 근사치일 수 있습니다. 내장 캡션의 위·아래 위치는 수동 확인이 필요합니다.
- 셀 병합을 전면 금지하지 않습니다. 양방향 병합은 단순화 검토 후보입니다.
- 기본 문서 입력 한도는 64 MiB, 구조 중첩 한도는 64단계입니다. 프로젝트의 자원 제한이며 공식 작성 원칙이 아닙니다.
- 문장 명확성·사실·수치·의미 보존은 원문 대조와 사람이 최종 검토합니다.
정적 CLI 검사는 로컬에서 실행합니다. 설치에는 인터넷이 필요할 수 있으며, 오프라인에서는 준비된 패키지와 npx --no-install을 사용하세요. 호스트 AI 에이전트의 외부 전송 정책은 별도로 확인해야 합니다.