DongHyeonkaandClaude Opus 5
aae43f4f99
저장 멱등 키가 필드 순서에 안 흔들리는 것은 sort_keys=True 덕이고, 그것은 JSON 을 안정적으로 만들려고 넣은 것이지 멱등성을 노린 것이 아니다. 다시 직렬화한 재시도가 새 저장으로 잡히지 않게 지키고 있었는데 그 성질을 명시한 시험이 없었다. sort_keys 를 빼도 아무 시험이 안 깨졌다. 의도하지 않은 성질에 기대는 코드는 회귀로 못박지 않으면 다음 사람이 지운다. 대조군도 함께 넣었다. 순서에 안 흔들린다고 내용에도 안 흔들리면 그건 다른 결함이다. 그리고 「Decision 은 계약에 삭제 경로가 없다」의 출처가 스킬이었다. 내가 코드 주석과 보고서로 옮긴 문장이 거기서 왔다. 다섯 종류 전부의 삭제 경로를 세어 표로 바꾸고 확인한 리비전(tech-log-backend @ a000f87)을 함께 적었다 — 서버를 서술할 때 리비전이 없으면 서버가 바뀌어도 아무도 모른다. 지워지지 않는 것은 따로 있다. 게시한 적이 있으면 DOCUMENT_PUBLISHED, 관계로 참조되면 DOCUMENT_IN_USE 다. 그것이 원래 말하려던 것이다. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q4vKjQo9KKBBokzxqXLCfk
160 lines
7.9 KiB
Markdown
160 lines
7.9 KiB
Markdown
---
|
|
name: publishing-tech-log-to-studio
|
|
description: Use when a finished Tech Log record .md must be put into Tech Log Studio through the browser with Playwright MCP — creating or opening the working copy, uploading assets, filling the per-kind fields, and saving. Save only; this skill never publishes.
|
|
metadata:
|
|
version: "1.0.0"
|
|
language: "ko-KR"
|
|
---
|
|
|
|
# Studio 반입 — 저장까지만
|
|
|
|
## 이 스킬의 경계
|
|
|
|
기록 `.md` 하나를 Studio 편집 화면에 넣고 **저장**한다. 거기서 끝난다.
|
|
|
|
**게시하지 않는다.** 게시는 공개 사이트에 올리는 일이고, 되돌리려면 `unpublish` 를 해야 하며
|
|
그 사이에 누구나 본다. 더 중요한 것은 **한 번이라도 게시한 문서는 게시를 취소해도 지워지지
|
|
않는다는 것이다** — 삭제가 409 로 거절되고 「공개된 기록은 삭제할 수 없습니다」가 뜬다. 그래서
|
|
시험 삼아 게시하지 않는다. 게시는 사람이 미리보기를 읽고 판단한다.
|
|
|
|
편집 화면 오른쪽 `aside` 에 버튼이 `저장`·`게시` 둘뿐이다. **`게시` 를 누르면 저장·검증·
|
|
미리보기·게시가 한 번에 돈다.** 이 스킬은 `저장` 만 누른다.
|
|
|
|
## 들어가기 전 조건
|
|
|
|
| 조건 | 확인 |
|
|
|---|---|
|
|
| 기록 `.md` 가 파서를 통과했다 | `studio-body.py` 로 바꾼 파일에 `check_body.mjs`, error 0 |
|
|
| 문장 검사를 지났다 | `check_prose.mjs` error 0 |
|
|
| 인용이 SSOT 에 실재한다 | `check_evidence.mjs <프로젝트> --repo` |
|
|
| 브라우저가 이미 로그인돼 있다 | 아래 「인증」 |
|
|
|
|
**검사를 안 지난 초안을 넣지 않는다.** 저장은 빈 칸도 받아 주기 때문에(Studio 는 한 번에 다
|
|
쓰지 않아도 저장되게 만들어져 있다) 넣는 것 자체는 성공한다. 그래서 파서·문장 검사를 여기서
|
|
대신 잡아 주지 않는다.
|
|
|
|
## 인증
|
|
|
|
Studio 는 조회에도 권한을 요구한다. 읽는 것이 게시 전 초안이기 때문이다.
|
|
|
|
**이 저장소에 자격증명을 두지 않는다.** 이미 로그인된 브라우저 세션을 쓴다. 편집 화면을 열었을
|
|
때 상태 `aside` 가 25초 안에 안 뜨면 **인증이 안 된 것으로 보고 멈춘다.** 로그인 화면을
|
|
자동으로 통과하려 들지 않는다 — 사용자에게 로그인해 달라고 말하고 기다린다.
|
|
|
|
```
|
|
aside[class*="studio-document-status"] ← 이것이 안 보이면 인증 실패
|
|
```
|
|
|
|
## 주소
|
|
|
|
| 무엇 | 주소 |
|
|
|---|---|
|
|
| Studio | `https://hyeonworks.com/studio` |
|
|
| 편집 화면 | `https://hyeonworks.com/studio/documents/<id>/edit` |
|
|
| 새 문서 | Studio 에서 `새 문서` → 종류 선택 → `작업본 만들기` |
|
|
|
|
기록 frontmatter 의 `id` 와 `studio:` 가 이미 차 있으면 **새로 만들지 않는다.** 그 주소로 바로
|
|
간다. 비어 있으면 새로 만들고, 받은 uuid 와 편집 주소를 기록 frontmatter 에 적는다.
|
|
|
|
## 절차
|
|
|
|
### 1. 기록을 읽고 무엇을 넣을지 정한다
|
|
|
|
`kind` 로 칸 목록이 정해진다. 어떤 `##` 제목이 Studio 의 어느 칸인지는
|
|
[references/studio-form-map.md](references/studio-form-map.md).
|
|
|
|
**frontmatter 는 메타데이터고, 본문의 `##` 가 Studio 의 칸이며, 제목 아래 첫 문단이 `요약`
|
|
이다.** 계약에 없는 `##` 는 화면에 자리가 없어 통째로 사라진다.
|
|
|
|
### 2. 그림이 있으면 Asset 을 먼저 올린다
|
|
|
|
frontmatter `assets:` 의 `file:` 이 올릴 파일이고 `key:` 는 저장소 쪽 이름이다. 올리면 서버가
|
|
`<이름>-<해시8>` 형태의 키를 준다.
|
|
|
|
**본문을 넣기 전에 올린다.** 순서를 뒤집으면 미리보기가 본문 전체를 막는다 —
|
|
`1:1 supported local evidence key not found: <asset-key>`. 다른 경로로 올렸으면 편집 화면을
|
|
한 번 새로 고쳐야 목록을 다시 받는다. 본문 문법 문제로 오해하기 쉽다.
|
|
|
|
본문은 서버가 준 키로 바꿔서 넣는다.
|
|
|
|
```bash
|
|
python3 scripts/studio-body.py <기록.md> --key <저장소 key>=<서버가 준 key> --body-only
|
|
```
|
|
|
|
저장소의 `.md` 는 마크다운 이미지로 두고 고치지 않는다. `:::evidence` 는 Studio 렌더러의
|
|
구문이라 저장소에 쓰면 편집기에서 그림이 안 보인다.
|
|
|
|
### 3. 칸을 채운다
|
|
|
|
되풀이되는 칸(`영향`·`선택지`·`사실`처럼 여러 줄인 것)은 **줄 수를 먼저 맞추고** 값을 넣는다.
|
|
줄이 모자란 채로 채우면 뒤엣것이 조용히 버려진다. 셀렉터와 배치 실행 방법은
|
|
[references/playwright-recipes.md](references/playwright-recipes.md).
|
|
|
|
**본문이 없는 세 종류(Reference·Question·Decision)의 칸은 평문으로 렌더링된다.** 백틱과
|
|
파이프가 글자 그대로 보이고, 줄바꿈은 `<br>` 로만 살아난다.
|
|
|
|
### 4. 저장한다
|
|
|
|
```
|
|
aside[class*="studio-document-status"] 안의 `저장` 버튼
|
|
→ 같은 aside 의 글자가 `저장됨` 으로 바뀔 때까지 기다린다 (최대 30초)
|
|
```
|
|
|
|
`저장됨` 을 못 보면 실패다. 그 `aside` 의 글자를 그대로 읽어서 보고한다. **버튼을 다시 누르지
|
|
않는다** — 검증 오류로 막힌 것을 연타로 뚫으려다 `게시` 를 누르게 된다.
|
|
|
|
버전은 같은 `aside` 의 첫 `dd` 에 있다. 저장 전후로 읽어 두면 실제로 올라갔는지 보인다.
|
|
|
|
### 5. 미리보기로 읽는다
|
|
|
|
`즉시 미리보기` 탭은 저장한 값이 아니라 **화면에 입력한 값**을 렌더링한다. 그래서 게시 없이도
|
|
공개 화면과 같은 블록 렌더러로 본문을 볼 수 있다.
|
|
|
|
읽을 항목은 `../writing-tech-log-records/references/studio-draft-review.md` 의 목록을 쓴다.
|
|
고칠 것이 있으면 `편집` 탭으로 돌아가 고치고 다시 저장한다.
|
|
|
|
### 6. 기록에 되적는다
|
|
|
|
새로 만들었으면 frontmatter 의 `id` 와 `studio:` 를 채우고 색인을 다시 만든다.
|
|
|
|
```bash
|
|
python3 scripts/build-tech-log-tree.py <프로젝트>
|
|
python3 scripts/verify-tech-log-tree.py <프로젝트>
|
|
```
|
|
|
|
`build-tech-log-tree.py` 는 frontmatter 의 `id` 가 있으면 `publication` 을 `게시됨` 으로
|
|
적는다. **이 칸은 「Studio 에 있다」는 뜻이지 「공개돼 있다」가 아니다.** 공개 여부는 기록의
|
|
`status` 와 `public:` 이 말한다.
|
|
|
|
## 시험용 초안을 남기지 않는다
|
|
|
|
확인하려고 만든 작업본은 지운다. **다섯 종류 전부 삭제 경로가 있다** —
|
|
`tech-log-backend` @ `a000f87` 의 `ManagementDocumentController` 에서 센 것이다.
|
|
|
|
| 종류 | 경로 |
|
|
|---|---|
|
|
| Case | `DELETE /v1/studio/cases/{id}` (`:72`) |
|
|
| Reference | `DELETE /v1/studio/references/{id}` (`:81`) |
|
|
| Concept | `DELETE /v1/studio/concepts/{id}` (`:95`) |
|
|
| Question | `DELETE /v1/studio/questions/{id}` (`:114`) |
|
|
| Decision | `DELETE /v1/studio/projects/{id}/decisions/{decisionId}` (`:123`) |
|
|
|
|
**전에 이 자리에 「Decision 은 계약에 삭제 경로가 없다」고 적혀 있었고 그것은 틀렸다.**
|
|
확인 없이 적힌 문장이 옮겨 다녔다 — 이 배치에서 그 문장을 코드 주석과 보고서로 다시 옮긴
|
|
일이 있었다. **서버를 서술할 때는 확인한 리비전을 함께 적는다.** 리비전이 없으면 서버가
|
|
바뀌어도 아무도 모른다.
|
|
|
|
**지워지지 않는 것은 따로 있다.** 게시한 적이 있으면 `DOCUMENT_PUBLISHED` 로 409 가 나고
|
|
(「공개된 기록은 삭제할 수 없습니다」), 관계로 참조된 문서는 `DOCUMENT_IN_USE` 로 막힌다
|
|
(「이 기록을 참조하는 곳이 있어 삭제할 수 없습니다」). 참조하는 쪽의 관계를 먼저 끊는다.
|
|
|
|
## 실패했을 때
|
|
|
|
| 증상 | 원인 |
|
|
|---|---|
|
|
| `aside` 가 안 뜬다 | 인증. 로그인 화면을 자동으로 넘기지 않는다 |
|
|
| 미리보기가 본문 전체를 막는다 | Asset 을 올리기 전에 본문을 넣었다. 화면을 새로 고친다 |
|
|
| 칸을 못 찾는다 (`label` 매치 0) | 그 종류에 없는 칸이다. `studio-form-map.md` 를 다시 본다 |
|
|
| 값이 잘렸다 | 되풀이 칸의 줄 수를 안 맞추고 채웠다 |
|
|
| `저장됨` 이 안 뜬다 | 검증이 막은 것이다. `aside` 글자를 읽어 보고한다 |
|