본문으로 건너뛰기

docs/ — 공통 규칙 및 안내

docs/ 전체에 적용되는 공통 규칙

이 디렉토리는 trustedoss의 모든 챕터 문서가 위치하는 곳이다. 각 챕터는 독립적인 하위 디렉토리로 구성되며, 00번부터 07번까지 순서대로 진행한다.

create-doc skill 적용

docs/ 하위 모든 문서는 .claude/skills/create-doc.md 에 정의된 표준을 따른다.

  • 문서 상단에 메타 블록 포함 (작성일, 버전, 충족 체크리스트, 셀프스터디 소요시간)
  • 섹션 순서 준수: 이 챕터에서 하는 일 → 배경 지식 → 셀프스터디 경로 → 완료 확인 → 다음 단계
  • 체크리스트 항목 참조 시 > 이 단계는 ISO/IEC 5230 [항목ID] 요구사항을 충족합니다. 형식 사용

챕터 간 이동 링크 규칙

다음 단계 안내 또는 다른 챕터 참조 시 반드시 Markdown 링크를 사용한다.

  • `docs/02-organization/` 처럼 backtick으로 경로를 표기하면 클릭 불가 — 금지
  • 올바른 형식: 대괄호 안에 해당 페이지 H1 제목, 소괄호 안에 현재 파일 기준 상대 경로를 작성한다
  • 링크 텍스트는 해당 페이지의 H1 제목을 그대로 사용한다
  • 경로는 현재 파일 기준 상대 경로로 작성한다 (../, ./ 등)
  • bash 코드블록은 실행 가능한 shell 명령어만 포함한다 (`cd docs/...` 는 금지)

Agent 실행 안내 형식 규칙

셀프스터디 경로에서 agent 실행을 안내할 때는 반드시:

  1. cd agents/... 코드블록 직전에 세션 종료 안내 admonition을 추가한다
  2. admonition 없이 bash 코드블록만 단독 배치하는 것은 금지한다

표준 형식:

:::tip[실행 전 확인]
현재 Claude 세션을 먼저 종료(`/exit` 또는 `Ctrl+C`)한 뒤, 새 터미널에서 아래 명령을 실행하세요.
:::

​```bash
cd agents/XX-agent-name
claude
```

이유: 독자는 현재 Claude 세션(루트에서 실행 중) 안에서 이 문서를 읽고 있으므로, 세션을 종료하지 않으면 cd agents/... 명령이 동작하지 않는다.

가이드 품질 기준

각 챕터는 독자가 아래 세 가지 질문에 답할 수 있어야 한다:

  1. 표준이 무엇을 요구하는가 — 배경 지식 섹션에서 해당 요구사항 항목(G번호, 섹션 번호) 명시
  2. 왜 해야 하는가 — 배경 지식 섹션에서 실제 사례 또는 미이행 시 결과 제시
  3. 어떻게 준수하는가 — 셀프스터디 경로에서 agent 실행 → 산출물 생성 단계 안내

사용 경로

  • 셀프스터디: docs/ 챕터를 00부터 순서대로 읽고 실습한다

산출물 저장 위치

모든 실습 산출물은 output/ 디렉토리에 저장된다. output/ 는 .gitignore 에 포함되어 있어 버전 관리 대상이 아니다.

output/
├── organization/ # 02-organization 챕터 산출물
├── policy/ # 03-policy 챕터 산출물
├── process/ # 04-process 챕터 산출물
├── sbom/ # 05-tools 챕터 산출물
├── vulnerability/ # 05-tools/vulnerability 산출물
├── training/ # 06-training 챕터 산출물
├── conformance/ # 07-conformance 챕터 산출물
└── progress.md # 전체 진행 상황 추적

막혔을 때

각 챕터 디렉토리로 이동하면 해당 폴더의 CLAUDE.md 가 세부 맥락을 제공한다. Agent를 활용하면 산출물을 자동으로 생성할 수 있다.

# 예시: 조직 설계 agent 실행
cd agents/02-organization-designer
claude