작성규칙
문서를 만들면서 정해진 것들을 여기에 쌓는다. 새 규칙이 생기면 맨 아래 「기록」에 날짜와 함께 한 줄 추가한다.
1. 단위와 파일
| 문서 하나 | 교재의 대단원 한 장 |
| 파일 위치 | 개념 문서는 docs/, 실험은 experiments/, 그림·코드는 assets/ |
| 폴더 | 위 셋만 쓴다. 과목별 폴더를 만들지 않는다 — 과목은 subject: 로 구분 |
| 파일 이름 | 곧 링크 이름이 된다. 나중에 바꾸면 번거로우니 처음에 정한다 |
2. 문서 맨 위
---
title: 압력용기
subject: 기계요소설계
chapter: 3
week: 3
author: 서창우
prereq: [주응력, 자유물체도]
tags: [수식유도]
---
실험 문서는 여기에 type: experiment, tools: [MATLAB], concepts: [...] 를 더한다.
코드 파일이 있으면 code: pv_stress.m 를 넣으면 제목 아래 실행 버튼이 생긴다.
3. 문서 구조
학습목표 "~할 수 있다" 형태로 3~4개
1. 절 제목 본문
2. 절 제목 본문
색 상자 필요한 자리에
실험 링크 있으면
학습목표는 "이해한다", "안다"로 쓰지 않는다. 확인이 안 되기 때문이다. 「구분할 수 있다」「계산할 수 있다」「설명할 수 있다」처럼 행동으로 확인되는 동사를 쓴다.
4. 색 상자 세 종류
<div class="callout callout-question" markdown="1">
<div class="callout-title">여기서 막힌다</div>
교재가 한 줄로 넘어가는데 실제로 학생이 걸리는 지점
</div>
<div class="callout callout-example" markdown="1">
<div class="callout-title">숫자로 보기</div>
기호 대신 실제 값을 넣어 감을 잡게 하는 곳
</div>
<div class="callout callout-warning" markdown="1">
<div class="callout-title">흔한 오해</div>
틀리기 쉬운 생각을 먼저 꺼내서 교정하는 곳
</div>
이 세 개가 교재 요약과 우리 문서를 가르는 지점이다. 교재는 지면이 아까워서 안 쓰지만, 학생이 실제로 막히는 건 정확히 거기다.
「용어 정의」를 상자에 넣지 않는다. 정의는 그 개념을 다루는 문서로 링크한다.
5. 링크
<a class="wlink" href="주응력.html">주응력</a> 기본
<a class="wlink" href="주응력.html">σ</a> 다르게 보이게
<a class="wlink" href="압력용기.html#4-왜-정확히-2배인가">압력용기</a> 특정 절로
| 규칙 | |
|---|---|
| 거는 자리 | 그 개념을 실제로 다루는 문장에만 |
| 횟수 | 문서 안에서 첫 등장 한 번만 |
| 방향 | 선수 개념 쪽으로만. 반대 방향은 자동 생성됨 |
| 개수 | 문서당 3~7개. 넘으면 개념이 너무 크다는 뜻 |
| 없는 문서 | 그대로 걸어둔다. 회색으로 표시되고, 그게 앞으로 쓸 목록이 된다 |
링크를 걸려고 본문 단어를 바꾸지 않는다. 한 번 그렇게 했다가 "안쪽 면과 바깥쪽 면의 응력"이 "주응력"으로 바뀌어 뜻이 틀어진 적이 있다.
실험 문서로 가는 링크도 <span class="link-missing" title="아직 없는 문서">실험_이름</span> 으로 쓴다. 화면에는 #실험_이름 해시태그 모양으로 나온다. Obsidian에서 # 로 쓰면 태그가 되어 이동이 안 된다.
6. 그림·수식·코드
<figure><img src="assets/pv_cylinder.jpg" alt="캡션은 그림 바로 다음 줄에 기울임으로" style="max-width:520px"><figcaption>캡션은 그림 바로 다음 줄에 기울임으로</figcaption></figure>
$r/t \ge 10$ 문장 속 수식
$$\sigma_1 = Pr/t$$ 가운데 정렬 수식
!<span class="link-missing" title="아직 없는 문서">pv_stress.m</span> 코드 파일을 통째로 박스에 넣음
그림은 Obsidian 창에 끌어다 놓으면 assets/ 에 저장된다.
코드는 assets/ 의 파일을 참조하므로, 코드를 고치면 사이트도 자동으로 바뀐다.
7. AI로 필기를 옮길 때
필기에 없는 수식·수치·조건은 절대 만들어 내지 않는다. 확실하지 않으면 [확인 필요] 로 표시하고 넘어간다.
AI가 옮긴 뒤에는 반드시 자기 필기와 대조해서 검수한다. 틀린 전공 내용이 올라가면 후배들이 그걸로 공부한다.
「여기서 막힌다」와 「흔한 오해」는 본인이 직접 채운다. 실제로 걸렸던 지점은 본인만 안다.
아직 안 정한 것
- 교재 장이 너무 길 때 어디서 끊을지
- 그림이 없는 개념을 어떻게 보여줄지
- 같은 개념을 두 사람이 동시에 썼을 때 합치는 방법
기록
새 규칙이 생기면 여기에 한 줄씩 추가한다.
| 날짜 | 정한 것 | 계기 |
|---|---|---|
| 2026-09-06 | 위 규칙 1~7 확정 | 압력용기 문서를 만들며 정리 |