본문으로 건너뛰기

문서 관리

폴더 구조

rogue-docs/
├── 0-팀/ — 팀 소개, 문화, 멤버 프로필
├── 1-운영/ — 조직 운영
│ └── 목표/ — 연간 전략 + 바이위클리 OKR + 관련 프로젝트 링크
├── 2-미팅/ — 모든 미팅 기록 (프로젝트 미팅 포함)
├── 3-프로젝트/ — 프로젝트별 폴더 (문서 + 코드)
│ ├── 병원 PoC/
│ ├── 크리에이터 PoC/
│ ├── 법률 PoC/
│ ├── 마오타이 마케팅 제안/
│ ├── 기본 업무 환경 구축/
│ └── 예비창업자패키지/
├── 4-자료/ — 첨부 자료 (이미지, PDF, 가이드)
├── 5-웹사이트/ — 웹사이트 프로젝트
│ └── rogue-website/
└── 9-시스템/ — 팀 운영 시스템 규칙 (이 폴더)
└── 템플릿/ — 문서 템플릿

문서 위치 기준

  • 팀 소개, 멤버 프로필 → 0-팀/
  • 목표, 전략, OKR → 1-운영/목표/
  • 미팅 기록 → 2-미팅/ (파일명: 날짜-프로젝트-주제.md)
  • 프로젝트 소속 → 3-프로젝트/{프로젝트명}/
  • 첨부 파일, 참고 자료 → 4-자료/

프로젝트 문서 규칙

  • 각 프로젝트 폴더에는 **개요.md**를 마스터 문서로 둔다 (목표, 전략, 계획, 현황, 회고)
  • 프로젝트 내부는 **문서/**와 **코드/**로 구분한다
    • 문서/ — 기획, 리서치, 제안서 등 사람이 읽는 파일
    • 코드/ — 스크립트, 크롤러, 웹사이트 등 실행되는 파일
  • 개요.mdCLAUDE.md 등 시스템 파일은 프로젝트 루트에 둔다

작성 규칙

  • 사람이 읽는 문서는 한국어 파일명 (개요.md, 기획안.md 등)
  • 시스템/도구용 파일은 영문 허용 (CLAUDE.md, .gitignore 등)
  • 폴더명, 내용 모두 한국어 (코드/기술 용어는 영문 허용)
  • 파일명 구분자는 하이픈(-)만 사용 (언더스코어 _ 금지): 마케팅-기획안.md, 리서치-시장분석.md
    • 코드 파일(.py, .js 등)은 해당 언어 컨벤션을 따름 (예: Python은 snake_case)
  • 커밋 메시지는 한국어
  • 민감 정보(API 키 등)는 절대 커밋하지 않음

문서 간 링크 규칙

  • 문서 간 참조가 가능하면 항상 상대 경로 링크를 건다
  • 형식: [표시 텍스트](상대/경로/파일.md)
  • 링크가 깨지면 즉시 수정한다

리스트 우선 규칙

  • 마크다운 테이블 대신 리스트를 기본으로 사용한다
  • 테이블은 열이 3개 이상이고 비교가 필요한 경우에만 허용한다
  • 목표, 전략 등 서술형 섹션도 불릿 리스트로 정리한다 (줄글 금지)
  • 이유: 마크다운 테이블은 편집이 어렵고 diff가 깨지기 쉬움, 줄글은 스캔이 어려움