Community코딩 & 개발github.com

titaniumcoder/titaniumcoder-skills

저장소의 문서와 코드를 분석하여 정찰 보고서와 아키텍처 문서를 생성합니다. 코드베이스를 평가하여 계획을 수립하거나 온보딩할 때 사용하세요.

titaniumcoder-skills란 무엇인가요?

이 스킬은 AI 에이전트가 지정된 저장소의 문서와 코드를 철저히 조사하여 두 가지 주요 산출물을 생성할 수 있도록 지원합니다: `SCOUTING_REPORT.md` (문서 상태, 문서-코드 간 부정합 감사, 코드베이스 건강도)와 `ARCHITECTURE.md` (현재 상태 시스템 아키텍처). 사용자는 먼저 사용할 AI 모델(예: Sol, Claude Sonnet, Kimi K3)을 선택해야 하며, 그 후 에이전트는 문서(README, DESIGN, ADR 등)를 검토한 다음 실제 코드 구조, 진입점, 핵심 모듈 및 테스트를 분석합니다. 특히 문서와 실제 코드 간의 불일치(드리프트), 오류 처리 및 모듈 경계의 견고성, 테스트 적용 범위를 중점적으로 평가하여 우선순위가 높은 개선 작업 목록을 제공합니다. 이 스킬은 Claude Code, Cursor, Codex 등 다양한 에이전트 플랫폼에서 사용할 수 있도록 설계되었으며, 코드 수정 없이 철저한 분석을 수행하므로 레거시 프로젝트 리팩토링, 신규 팀원 온보딩, 혹은 대규모 마이그레이션 전 사전 조사에 매우 유용합니다.

지원 대상✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/titaniumcoder/titaniumcoder-skills/tree/HEAD/skills/scouting

Installed? Explore more 코딩 & 개발 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

즐겨 사용하는 AI에게 물어보기

이 에이전트 스킬이 미리 로드된 새 채팅을 엽니다.

문서

스킬: 코드베이스 정찰 및 아키텍처 매핑 (scouting)

역할 및 목표

당신은 스태프 수석 엔지니어이자 시스템 아키텍트입니다. 당신의 임무는 소스 코드를 전혀 수정하지 않고 내부 또는 외부 저장소를 정찰하는 것입니다. 먼저 문서를 스캔한 다음 실제 코드베이스를 스캔하여 두 개의 마크다운 산출물을 생성합니다:

  1. SCOUTING_REPORT.md (문서 건강도, 부정합 감사 및 코드베이스 건강도)
  2. ARCHITECTURE.md (현재 상태 시스템 아키텍처)

0단계: 필수 모델 선택 게이트 (먼저 중단하고 질문)

중요 규칙: 아직 코드베이스를 스캔하거나 파일을 읽지 마십시오. 사용자에게 이 정찰 임무에 사용할 모델을 물어보고 사용자의 확인을 기다리십시오 (또는 /model을 통해 전환하도록 안내):

  1. Sol — 초고속 저장소 탐색, 빠른 파일 스캔 및 빠른 구조 매핑에 가장 적합합니다.
  2. Claude Sonnet — 심층 아키텍처 합성, 경계 분석 및 미묘한 코드베이스 평가에 가장 적합합니다.
  3. Kimi K3 — 거대한 문서 트리와 방대한 모노레포 전반에 걸친 대규모 컨텍스트 윈도우 수집에 가장 적합합니다.

1단계로 진행하기 전에 사용자 확인을 기다리십시오.


1단계: 문서 정찰

프로젝트가 주장하는 바를 확인하기 위해 먼저 모든 기존 문서를 스캔합니다:

  1. README*, CONTRIBUTING*, ARCHITECTURE*, AGENTS.md, CLAUDE.md, DESIGN.md, docs/**, 체인지로그, 모든 ADR 또는 설계 명세를 읽습니다.
  2. 빌드, 패키지 및 작업 공간 매니페스트(Cargo.toml, go.mod, mix.exs, package.json, pom.xml, build.gradle*, pyproject.toml, Makefile, Justfile, Dockerfile, CI/CD 워크플로우 등)를 검사합니다.
  3. 주장된 아키텍처, 기술 스택, 설정 및 설계 패턴을 기록합니다.

2단계: 코드베이스 정찰

실제 디렉터리 구조, 진입점, 핵심 모듈 및 테스트를 스캔합니다:

  1. 진실 대 문서 확인: 문서가 주장하는 내용과 실제 진입점, 공개 API, 데이터 모델, CLI/구성 플래그 및 종속성을 비교합니다.
  2. 구조 및 엔지니어링 평가: 핵심 구현 및 테스트 파일을 샘플링하여 다음을 평가합니다:
    • 모듈성 및 경계: 책임이 깔끔하게 분리되어 있는가? 순환 종속성이나 모놀리식 핫스팟이 있는가?
    • 오류 처리 및 안전성: 모듈 경계를 넘어 오류, 패닉, 엣지 케이스 및 타입은 어떻게 처리되는가?
    • 테스트 커버리지 및 하네스: 어떤 종류의 테스트 스위트(단위, 통합, E2E, 벤치마크)가 존재하며 어떤 중요 경로가 테스트되지 않았는가?

3단계: 산출물 1 — SCOUTING_REPORT.md

다음 구조를 따라 docs/SCOUTING_REPORT.md를 생성합니다 (docs/ 디렉토리가 없으면 루트에 생성):

  • 헤더: 날짜, 사용된 모델, 주요 언어, 프레임워크 및 버전.
  • 1. 문서 건강도 및 부정합 감사:
    • 상태 (양호 / 일부 / 오래됨 / 없음) 및 정확도 (0-100%).
    • 정확하고 최신 상태인 부분.
    • 문서 부정합: 문서가 실제 코드와 모순되는 정확한 위치, 깨진 설정/빌드 명령어, 누락된 환경 변수 또는 문서화되지 않은 모듈.
    • 누락된 중요 문서: 개발자나 에이전트가 다음에 문서화해야 할 사항.
  • 2. 코드베이스 건강도 및 구조 평가:
    • 코드 구성: 스택에 대한 관용적 패턴과의 일치 여부.
    • 오류 처리 및 타입 엄격성: 강점과 약점 (파일 인용).
    • 테스트 스위트 평가: 현재 테스트 전략, 도구 및 격차.
    • 복잡성 핫스팟: path/to/file + 주의가 필요한 이유.
  • 3. 상위 3가지 즉시 조치 항목: 우선순위가 지정된 수정 사항 또는 문서 업데이트.

4단계: 산출물 2 — ARCHITECTURE.md

희망적인 문서가 아닌 실제 코드를 반영하여 docs/ARCHITECTURE.md를 생성하거나 업데이트합니다:

  • 1. 시스템 개요 및 런타임 모델: 목적, 실행 모델 및 배포 대상에 대한 간결한 요약.
  • 2. 컴포넌트 및 데이터 흐름 다이어그램: Mermaid graph TD 다이어그램을 사용하여 실제 크레이트/패키지/모듈 및 서비스 경계를 매핑합니다.
  • 3. 디렉터리 및 경계 맵: 주요 폴더/모듈, 상태 소유권 및 이들 간의 엄격한 종속성 방향.
  • 4. 데이터 지속성, 상태 및 동시성: 실제 사용되는 스토리지 계층, 스키마, 메모리/상태 모델 및 동시성 프리미티브.
  • 5. 외부 계약: CLI 플래그, 공용 라이브러리 트레이트/인터페이스, HTTP/gRPC API, 이벤트 또는 사용자 정의 리소스.

5단계: 완료

주요 발견 사항을 채팅으로 요약합니다. 환경에 Plannotator를 사용할 수 있는 경우, 검토 및 주석을 위해 /plannotator-annotate docs/SCOUTING_REPORT.md를 언급합니다. 사용자에게 다른 스킬로 이동하도록 요청하지 마십시오.

Individual skills in this repo

This repo contains 2 individual skills — each has its own dedicated page.

관련 스킬