modify template
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
# Report Decision Records
|
||||
|
||||
## 철학
|
||||
보고서는 빠르게 그럴듯한 문장을 만드는 것이 아니라, 사용자가 판단할 수 있는 근거를 축적하고 그 근거로부터 결론을 구성하는 작업이다. 속도보다 출처, 검증 가능성, 피드백 반복성을 우선한다.
|
||||
|
||||
---
|
||||
|
||||
### ADR-001: 문서 파일을 단일 진실 공급원으로 사용
|
||||
**결정**: 보고서 입력, 리서치 로그, 초안, 피드백을 모두 `docs/` 아래 Markdown 파일로 관리한다.
|
||||
**이유**: 독립된 Codex 세션과 phase 실행 사이에서도 맥락을 잃지 않고 이어갈 수 있다.
|
||||
**트레이드오프**: 문서가 길어질수록 정리 비용이 늘어나므로 중복 출처와 폐기된 주장 정리가 필요하다.
|
||||
|
||||
### ADR-002: 웹 검색과 출처 기록을 기본값으로 둔다
|
||||
**결정**: 최신성 또는 사실 정확성이 필요한 보고서 내용은 웹 검색 후 `docs/RESEARCH_LOG.md`에 출처를 기록한다.
|
||||
**이유**: 보고서 품질은 모델 기억보다 검증 가능한 근거에 의해 결정된다.
|
||||
**트레이드오프**: 초안 작성 속도는 느려지지만, 사용자가 검토하고 수정할 수 있는 근거가 남는다.
|
||||
|
||||
### ADR-003: 초안 작성 전에 리서치 로그를 먼저 축적한다
|
||||
**결정**: 바로 본문을 쓰지 않고 리서치 질문, 검색 결과, 상충 근거, 한계를 먼저 정리한다.
|
||||
**이유**: 결론이 근거보다 앞서가는 것을 막고, 보고서 방향성을 더 쉽게 조정할 수 있다.
|
||||
**트레이드오프**: 짧은 보고서에도 최소한의 리서치 단계가 필요하다.
|
||||
|
||||
### ADR-004: 피드백 반복을 명시적 산출물로 관리한다
|
||||
**결정**: 사용자 피드백은 `docs/FEEDBACK.md`에 원문과 반영 결과를 함께 기록한다.
|
||||
**이유**: 반복 작성 과정에서 어떤 요구가 반영되었고 무엇이 보류되었는지 추적할 수 있다.
|
||||
**트레이드오프**: 피드백 관리 문서를 별도로 갱신해야 한다.
|
||||
@@ -0,0 +1,71 @@
|
||||
# 보고서 생성 아키텍처
|
||||
|
||||
## 디렉토리 구조
|
||||
```text
|
||||
docs/
|
||||
├── PRD.md # 사용자가 입력하는 보고서 브리프
|
||||
├── ARCHITECTURE.md # 보고서 생성 흐름과 산출물 구조
|
||||
├── ADR.md # 리서치/작성 의사결정
|
||||
├── UI_GUIDE.md # 보고서 문체와 형식 가이드
|
||||
├── RESEARCH_LOG.md # 웹 검색 결과, 출처, 검증 메모
|
||||
├── REPORT_DRAFT.md # 현재 보고서 초안
|
||||
└── FEEDBACK.md # 사용자 피드백과 반영 이력
|
||||
|
||||
phases/
|
||||
├── index.json
|
||||
└── {phase}/
|
||||
├── index.json
|
||||
├── step0.md
|
||||
├── step1.md
|
||||
└── stepN.md
|
||||
```
|
||||
|
||||
## 에이전트 역할 패턴
|
||||
- Research Lead: 브리프를 읽고 리서치 질문, 검색 범위, 단계 계획을 정의한다.
|
||||
- Domain Researcher: 특정 키워드, 산업, 지역, 기간을 맡아 웹 검색하고 근거를 축적한다.
|
||||
- Source Reviewer: 출처 신뢰도, 최신성, 상충 자료, 과장된 해석을 점검한다.
|
||||
- Outline Writer: 리서치 로그를 바탕으로 보고서 구조와 핵심 메시지를 설계한다.
|
||||
- Report Editor: 초안을 작성하고 문체, 흐름, 근거 연결, 피드백 반영을 정리한다.
|
||||
|
||||
하나의 Codex 세션이 여러 역할을 수행할 수 있다. 사용자가 명시적으로 subagent 사용을 요청한 경우에만 병렬 subagent를 구성한다.
|
||||
|
||||
## 데이터 흐름
|
||||
```text
|
||||
사용자 입력
|
||||
-> docs/PRD.md
|
||||
-> phase plan 생성
|
||||
-> 웹 검색 및 출처 검증
|
||||
-> docs/RESEARCH_LOG.md 축적
|
||||
-> 개요와 논점 정리
|
||||
-> docs/REPORT_DRAFT.md 초안 작성
|
||||
-> 사용자 피드백 요청
|
||||
-> docs/FEEDBACK.md 기록
|
||||
-> 추가 검색/수정 반복
|
||||
```
|
||||
|
||||
## 산출물 불변식
|
||||
- `docs/PRD.md`는 사용자 의도와 범위의 단일 진실 공급원이다.
|
||||
- `docs/RESEARCH_LOG.md`는 모든 핵심 사실과 출처의 단일 진실 공급원이다.
|
||||
- `docs/REPORT_DRAFT.md`에는 검증된 근거와 명시된 한계만 반영한다.
|
||||
- `docs/FEEDBACK.md`에는 피드백 원문, 해석, 반영 여부, 미반영 이유를 기록한다.
|
||||
- `phases/{phase}/index.json`은 단계 실행 상태의 단일 진실 공급원이다.
|
||||
|
||||
## 리서치 기록 단위
|
||||
각 출처는 아래 필드를 포함해야 한다.
|
||||
|
||||
```text
|
||||
- 주장/논점:
|
||||
- 출처 제목:
|
||||
- 발행기관:
|
||||
- URL:
|
||||
- 발행일:
|
||||
- 접근일:
|
||||
- 핵심 내용:
|
||||
- 신뢰도 메모:
|
||||
- 보고서 반영 위치:
|
||||
```
|
||||
|
||||
## 상태 관리
|
||||
- 보고서 상태는 별도 애플리케이션 상태가 아니라 문서 파일의 변경 이력으로 관리한다.
|
||||
- 단계 상태는 `phases/{phase}/index.json`의 `pending`, `completed`, `error`, `blocked`로 관리한다.
|
||||
- 사용자의 추가 판단이 필요한 경우 Codex는 추측하지 말고 해당 step을 `blocked`로 표시하고 `blocked_reason`을 기록한다.
|
||||
@@ -0,0 +1,15 @@
|
||||
# Feedback Log
|
||||
|
||||
이 파일은 사용자 피드백, 해석, 반영 여부, 추가 리서치 필요 사항을 기록한다.
|
||||
|
||||
## Feedback 001
|
||||
- 날짜: {YYYY-MM-DD}
|
||||
- 피드백 원문: {사용자 피드백}
|
||||
- 해석: {보고서에 어떤 변경이 필요한지}
|
||||
- 반영 위치: {docs/REPORT_DRAFT.md 섹션명 또는 기타 파일}
|
||||
- 상태: {pending | applied | rejected | needs-research}
|
||||
- 미반영 이유: {해당 시 작성}
|
||||
|
||||
## 다음 반복에서 확인할 사항
|
||||
- {확인할 사항 1}
|
||||
- {확인할 사항 2}
|
||||
@@ -0,0 +1,54 @@
|
||||
# Report Brief: {보고서 제목}
|
||||
|
||||
## 입력 상태
|
||||
- 작성 상태: {draft | ready-for-research | ready-for-draft | revision}
|
||||
- 마지막 업데이트: {YYYY-MM-DD}
|
||||
- 작성자/요청자: {이름 또는 팀}
|
||||
|
||||
## 보고서 주제
|
||||
{무엇에 대한 보고서인지 한 문장으로 작성한다.}
|
||||
|
||||
## 용도
|
||||
{이 보고서가 사용될 의사결정, 회의, 내부 공유, 투자 검토, 전략 수립, 정책 검토, 기술 검토 등의 목적을 적는다.}
|
||||
|
||||
## 핵심 키워드
|
||||
- {키워드 1}
|
||||
- {키워드 2}
|
||||
- {키워드 3}
|
||||
- {산업, 기업, 지역, 기간, 제도, 기술, 이해관계자 등}
|
||||
|
||||
## 방향성
|
||||
{중립 분석, 찬반 비교, 시장 전망, 실행 전략, 리스크 중심, 정책 영향 분석, 기술 타당성 검토 등 원하는 논조와 분석 방향을 적는다.}
|
||||
|
||||
## 독자
|
||||
- 주요 독자: {임원, 실무자, 투자자, 고객, 정책 담당자 등}
|
||||
- 독자의 배경지식: {낮음 | 중간 | 높음}
|
||||
- 독자가 보고서로 결정해야 하는 것: {결정 또는 행동}
|
||||
|
||||
## 산출물 형식
|
||||
- 형식: {요약 보고서 | 심층 보고서 | 임원 브리프 | 조사 메모 | 백서 초안 | 발표자료용 원고}
|
||||
- 목표 분량: {예: 3쪽, 10쪽, 2,000자, 8개 섹션}
|
||||
- 언어와 문체: {예: 한국어, 전문적이고 간결한 문체}
|
||||
- 표/그림 요구: {예: 비교표 필수, 그래프 후보 제안, 이미지 불필요}
|
||||
|
||||
## 반드시 포함할 질문
|
||||
1. {질문 1}
|
||||
2. {질문 2}
|
||||
3. {질문 3}
|
||||
|
||||
## 제외 범위
|
||||
- {다루지 않을 내용 1}
|
||||
- {다루지 않을 내용 2}
|
||||
- {다루지 않을 내용 3}
|
||||
|
||||
## 성공 기준
|
||||
- {성공 기준 1: 예: 핵심 주장마다 출처가 있다}
|
||||
- {성공 기준 2: 예: 독자가 실행 결정을 내릴 수 있는 권고가 있다}
|
||||
- {성공 기준 3: 예: 불확실성과 반대 근거가 별도 정리되어 있다}
|
||||
|
||||
## 사용자 피드백 질문
|
||||
초안 작성 후 사용자에게 반드시 확인할 질문을 적는다.
|
||||
|
||||
1. {확인 질문 1}
|
||||
2. {확인 질문 2}
|
||||
3. {확인 질문 3}
|
||||
@@ -0,0 +1,36 @@
|
||||
# Report Draft: {보고서 제목}
|
||||
|
||||
## Executive Summary
|
||||
{핵심 결론과 권고를 3~5개 문장 또는 bullet로 작성한다.}
|
||||
|
||||
## 배경과 문제 정의
|
||||
{보고서 주제의 맥락, 독자가 알아야 할 배경, 분석 범위를 작성한다.}
|
||||
|
||||
## 핵심 발견사항
|
||||
1. {발견사항 1}
|
||||
2. {발견사항 2}
|
||||
3. {발견사항 3}
|
||||
|
||||
## 세부 분석
|
||||
{근거와 출처를 연결해 분석을 작성한다.}
|
||||
|
||||
## 리스크와 불확실성
|
||||
- {리스크 1}
|
||||
- {리스크 2}
|
||||
- {데이터 한계 또는 추가 확인 필요 사항}
|
||||
|
||||
## 선택지 또는 시나리오
|
||||
| 선택지 | 장점 | 단점 | 필요한 조건 |
|
||||
|--------|------|------|-------------|
|
||||
| {선택지 A} | {장점} | {단점} | {조건} |
|
||||
|
||||
## 권고안
|
||||
{보고서 목적에 맞는 판단, 실행 순서, 의사결정 포인트를 작성한다.}
|
||||
|
||||
## 참고 출처
|
||||
- {출처명, URL, 발행일 또는 접근일}
|
||||
|
||||
## 사용자 피드백 질문
|
||||
1. {초안 검토 질문 1}
|
||||
2. {초안 검토 질문 2}
|
||||
3. {초안 검토 질문 3}
|
||||
@@ -0,0 +1,31 @@
|
||||
# Research Log
|
||||
|
||||
이 파일은 보고서 작성에 사용되는 웹 검색 결과와 검증 메모를 축적하는 공간이다. 출처 없는 핵심 주장은 보고서 본문에 단정적으로 반영하지 않는다.
|
||||
|
||||
## 리서치 질문
|
||||
1. {질문 1}
|
||||
2. {질문 2}
|
||||
3. {질문 3}
|
||||
|
||||
## 출처 목록
|
||||
|
||||
### Source 001: {출처 제목}
|
||||
- 주장/논점: {이 출처가 뒷받침하거나 반박하는 주장}
|
||||
- 발행기관: {기관명}
|
||||
- URL: {https://...}
|
||||
- 발행일: {YYYY-MM-DD 또는 알 수 없음}
|
||||
- 접근일: {YYYY-MM-DD}
|
||||
- 핵심 내용: {보고서에 필요한 내용 요약}
|
||||
- 신뢰도 메모: {1차 자료/공식 문서/언론/블로그/이해관계 여부}
|
||||
- 보고서 반영 위치: {섹션명 또는 미반영}
|
||||
|
||||
## 상충 근거
|
||||
| 쟁점 | 출처 A | 출처 B | 해석 |
|
||||
|------|--------|--------|------|
|
||||
| {쟁점} | {요약} | {요약} | {어떻게 다룰지} |
|
||||
|
||||
## 검증 필요
|
||||
- {출처가 부족하거나 추가 확인이 필요한 주장}
|
||||
|
||||
## 폐기한 주장
|
||||
- {근거 부족, 오래된 자료, 방향성 불일치 등으로 제외한 내용과 이유}
|
||||
@@ -0,0 +1,53 @@
|
||||
# 보고서 스타일 가이드
|
||||
|
||||
## 작성 원칙
|
||||
1. 독자가 먼저 결론을 파악하고, 바로 근거와 한계를 확인할 수 있게 쓴다.
|
||||
2. 핵심 주장은 출처, 수치, 비교 기준 중 하나 이상으로 뒷받침한다.
|
||||
3. 불확실성, 반대 근거, 데이터 한계는 숨기지 않고 별도 문단으로 정리한다.
|
||||
4. 사용자의 방향성을 따르되 근거와 충돌하면 충돌 사실을 명시한다.
|
||||
|
||||
## 기본 구조
|
||||
보고서 형식이 별도로 지정되지 않았다면 아래 구조를 사용한다.
|
||||
|
||||
1. Executive Summary
|
||||
2. 배경과 문제 정의
|
||||
3. 핵심 발견사항
|
||||
4. 세부 분석
|
||||
5. 리스크와 불확실성
|
||||
6. 선택지 또는 시나리오
|
||||
7. 권고안
|
||||
8. 참고 출처
|
||||
9. 사용자 피드백 질문
|
||||
|
||||
## 문체
|
||||
- 한국어 기본 문체는 전문적이고 간결하게 쓴다.
|
||||
- 과장 표현, 광고 문구, 막연한 낙관론을 피한다.
|
||||
- `중요하다`, `빠르게 성장한다`, `리스크가 크다` 같은 표현은 가능한 한 근거를 붙인다.
|
||||
- 숫자는 단위와 기준 시점을 함께 쓴다.
|
||||
- 상대 날짜는 절대 날짜로 풀어 쓴다. 예: `최근` 대신 `2025년 4분기 이후`.
|
||||
|
||||
## 표와 목록
|
||||
- 비교, 장단점, 출처 충돌, 시나리오 분석은 표를 우선 사용한다.
|
||||
- 5개 이상의 병렬 항목은 목록으로 정리한다.
|
||||
- 표에는 비교 기준을 명확히 적는다.
|
||||
|
||||
## 출처 표기
|
||||
- 본문에는 간결한 출처명을 적고, 상세 정보는 `참고 출처` 또는 `docs/RESEARCH_LOG.md`에 둔다.
|
||||
- URL만 나열하지 말고 출처가 뒷받침하는 주장을 함께 적는다.
|
||||
- 출처가 오래되었거나 이해관계가 있으면 신뢰도 메모를 남긴다.
|
||||
|
||||
## 하지 말 것
|
||||
| 금지 사항 | 이유 |
|
||||
|-----------|------|
|
||||
| 출처 없는 수치 단정 | 검증 불가능한 보고서가 됨 |
|
||||
| 검색 결과 상위 문서만 요약 | 편향과 최신성 오류 가능성이 큼 |
|
||||
| 결론부터 정하고 근거를 끼워 맞춤 | 분석 신뢰도를 떨어뜨림 |
|
||||
| 사용자가 준 키워드 누락 | 입력 의도와 산출물이 어긋남 |
|
||||
| 피드백 반영 여부 미기록 | 반복 작업에서 맥락이 사라짐 |
|
||||
|
||||
## 최종 점검
|
||||
- 보고서 주제, 용도, 키워드, 방향성이 본문에 반영되었는가?
|
||||
- 핵심 주장마다 출처 또는 검증 메모가 있는가?
|
||||
- 상충 근거와 한계를 다루었는가?
|
||||
- 독자가 취할 수 있는 다음 행동이 분명한가?
|
||||
- 사용자에게 확인할 피드백 질문이 남아 있는가?
|
||||
Reference in New Issue
Block a user