Files
brain_dogfood/docs/user_manual.md
T

5.7 KiB

📔 뇌사료 (Brain Dogfood) 사용자 매뉴얼 (v5.0+)

'뇌사료' 프로젝트에 오신 것을 환영합니다! 본 매뉴얼은 파편화된 영감을 체계적인 지식 성단(Nebula)으로 구축하는 데 필요한 모든 가이드를 제공합니다.


🌌 1. 지식 네뷸라 (시각화 탐색)

메인 전면에 펼쳐진 지식 네뷸라는 단순한 목록이 아닌 지식의 유기적인 지도를 보여줍니다.

  • 노드(Node): 각각의 메모를 상징합니다.
    • 크기: 내용이 많거나 연결이 많을수록 노드가 거대해집니다.
    • 색상: 각 메모에 설정된 고유한 그룹 색상을 따릅니다.
    • 🔒 아이콘: 암호화된 메모임을 나타내며, 제목만 미리보기로 제공됩니다.
  • 링크(Link):
    • 실선: [[#ID]] 문법으로 명시적으로 연결된 관계입니다.
    • 인력(Gravity): 같은 그룹이나 공통 태그를 가진 메모들은 서로를 끌어당겨 가까이 배치됩니다.

🌡️ 3. 지식 성장 히트맵 (Heatmap) 사용법

사이드바에 위치한 히트맵은 사용자의 기록 강도를 시각적으로 보여줍니다.

  • 기간 전환: 히트맵 상단 제목 옆의 드롭다운을 통해 1개월 / 3개월 / 6개월 / 1년 단위를 선택할 수 있습니다.
  • 상태 유지: 한 번 선택한 기간은 브라우저에 저장되어 다음 접속 시에도 그대로 유지됩니다.
  • 활동량 확인: 각 칸에 마우스를 올리면 해당 날짜에 작성된 메모의 개수를 확인할 수 있습니다. 색상이 진해질수록(Cyan -> Purple) 더 많은 지식을 축적했음을 의미합니다.

✍️ 4. 메모 작성 및 스타일링

4.1 지식 연결 문법 ([[#ID]])

메모 간의 명시적인 지식을 연결하려면 본문에 샵(#) 기호와 메모 번호를 사용하세요.

예: "이 개념은 [[#12]]에서 다룬 내용과 상충됩니다."

  • 효과: 뷰어에서 클릭 시 해당 메모로 바로 이동하며, 지식 네뷸라 상에 강력한 연결선이 형성됩니다.

4.2 컬러 텍스트 (Color Syntax)

에디터 상단 툴바의 색상 선택 아이콘을 사용하여 텍스트에 색상을 입힐 수 있습니다. 중요 키워드를 강조하여 지식의 가독성을 높이세요.

4.3 개별 메모 암호화

중요한 개인 정보나 아이디어는 암호화하여 보호할 수 있습니다.

  • 사용법: 편집기 하단의 [암호화 사용] 체크 -> 비밀번호 설정.
  • 특약: 암호화된 메모는 서버 측에서도 해독이 불가능하며, 비밀번호 분실 시 복구가 절대 불가능하므로 주의하세요.
  • 복호화: 작성된 암호화 메모 옆의 🔓 해독 버튼을 눌러 비밀번호 입력 시 일시적으로 내용을 확인할 수 있습니다.


🧠 5. AI 인텔리전스 (AI Insights)

5.1 AI 활성화 및 API 키 설정 (초보자 가이드)

'뇌사료'의 지능형 기능을 사용하려면 Google의 Gemini API 키가 필요합니다. 다음 단계에 따라 1분 만에 무료로 설정을 마칠 수 있습니다.

  1. 키 발급: Google AI Studio (https://aistudio.google.com/app/apikey)에 접속합니다.
  2. 프로젝트 생성: "Create API key in new project" 버튼을 누릅니다.
  3. 키 복사: 생성된 AIza...로 시작하는 긴 문자열을 복사합니다.
  4. 서버 적용: 본 프로젝트 폴더의 .env 파일을 열고 GEMINI_API_KEY= 뒤에 복사한 키를 붙여넣고 저장합니다.
  5. 활성화: 앱 우상단 [⚙️ 설정] -> AI 기능 활성화 체크박스를 켜고 저장합니다.

Tip

  • API 키 발급은 완전히 무료이며, 개인적인 용도로는 충분한 할당량이 제공됩니다.
  • 키가 없더라도 메모 작성 및 시각화 등 기본적인 기능은 "NO AI" 모드로 완벽하게 작동합니다.

5.2 주요 기능

  • 자동 요약: 방대한 내용을 AI가 1~2문장의 핵심 문장으로 압축해줍니다.
  • 스마트 태그: 본문을 분석하여 자동으로 추천 태그를 생성합니다.
  • 추론형 배치: AI가 생성한 태그를 기반으로 지식 네뷸라 상에서 비슷한 맥락의 메모들이 자동으로 성단을 형성합니다.


⌨️ 6. 단축키 및 작업 효율 (Shortcuts)

'뇌사료'는 마우스 없이도 거의 모든 작업을 수행할 수 있도록 강력한 Ctrl 기반 단축키를 지원합니다.

6.1 전역 내비게이션

  • Alt + (Backtick): Quake 스타일 새 메모 (영감을 즉시 기록)
  • Ctrl + Shift + N: 새 메모 작성기 열기 📝
  • Ctrl + Shift + G: 지식 네뷸라(시각화) 열기 🕸️
  • Ctrl + Shift + E: 지식 탐색기(사이드바) 열기 🔍
  • Ctrl + Shift + C: 사이드바 캘린더 토글 📅
  • Ctrl + Shift + Q 또는 ESC: 모든 모달 및 드로어 닫기

6.2 에디터 작업

  • Ctrl + Enter 또는 Ctrl + S: 현재 메모 저장 및 게시 💾
  • / (Slash): 슬래시 명령 오픈 (AI 요약, 서식 등) 🪄
  • Shift + ESC: 작성 취소 및 닫기

6.3 마우스 팁

  • Alt + 클릭: 메인 그리드에서 메모를 즉시 수정 ✏️

🚀 7. 운영 및 관리 (Ops & Backup)

7.1 정밀 배포 (deploy.py)

개발 환경에서 작업한 코드를 서버로 안전하게 배포합니다.

python deploy.py

7.2 재난 복구 백업 (backup.py)

서버의 모든 핵심 데이터를 압축하여 안전하게 보관합니다.

python backup.py

지식의 우주를 마음껏 탐험하세요! 🛸🌌