
AI 공정별 문서 운용 가이드
요약
소프트웨어 개발 공정별 문서 운용 가이드를 통해 품질과 속도를 동시에 높이는 방법을 제시합니다. 경영진부터 개발자까지 각 역할에 맞는 문서 루트를 정의하고, 특히 AI 에이전트 활용 시의 문서 투입 규칙을 다룹니다.
핵심 포인트
- 정본(Single Source of Truth) 집약으로 품질과 속도 동시 향상
- 역할별(경영진, PM, SE, PG) 최적화된 문서 참조 경로 제공
- AI 에이전트 활용 시 AGENTS.md를 입구로 하는 체계적 정보 전달
- 프롬프트 투입 시 모든 문서를 일괄 투입하지 말고 필요한 문서만 선별
- 정보 보안을 위해 정보 분류에 따른 AI 투입 여부 판단 필수
알고 싶은 사람이 있을지 모르겠기에(조사와 실지 검사, 축적 및 증류만 하면 되기에) 가볍게 살짝 보여드립니다.
"품질을 위해 시간이 걸리는" 것이 아니라, 정본(正本)을 한 곳에 집약함으로써 품질과 속도가 동시에 올라간다는 것을 각 장의 Before/After로 보여드립니다.
| 입장 | 권장 루트 |
|---|---|
| 경영진 | [[00_경영진용]] → [[07_PM·정보 공유]] → [[08_마스터 서머리]] |
| PM | [[00_경영진용]] → [[07_PM·정보 공유]]. 게이트 전에는 01·05·06 |
| SE | [[01_요구사항 정의]] → [[02_기본 설계·ADR]] → [[03_API·OpenAPI]] → [[05_테스트·QA]]. 인수인계는 06 |
| PG | [[03_API·OpenAPI]] → [[04_구현]] |
[!tip] PDF 배포
[[08_마스터 서머리]] + [[00_경영진용]]을 브라우저 인쇄("배경 그래픽"을 켬)하는 것을 추천합니다.
| 장 | 노트 | HTML |
|---|---|---|
| 0 | [[00_경영진용]] | 경영진용 |
| ... | ||
| 공정 | 주요 산출물 | |
| --- | --- | |
| 제안 | baseline-agreements.md · 제안 서머리.html | |
| 요구 | REQ-xxx.md · customer/*.html · glossary | |
| 설계 | design.md · adr/ADR-xxx.md · C4.mmd | |
| API | openapi/**/*.yaml · bundled · Redoc | |
| 구현 | AGENTS.md · PR · 생성형 | |
| 테스트 | TestDesignDoc.md · traceability.csv | |
| 운용 | runbooks/*.md · CHANGELOG | |
| PM | open-items.md · gate-decision.md |
각 장 노트 말미에 구체적인 샘플(파일명·발췌)이 있습니다.
HTML 버전: ../04_implementation.html
[!abstract] 이 장의 읽는 법
구현·PG용. AGENTS.md가 입구. PR에서 docs 동봉.
주요 독자: PG · SE
# AGENTS.md (발췌)
## 읽는 순서
1. docs/steering/01_product.md
...
| Before (PG) | After (PG) |
|---|---|
| Slack으로 사양 확인 | AGENTS.md가 배경을 유지 |
| ... |
읽기 순서: AGENTS.md (항시) → 대상 REQ의 md만 → 필요 시 openapi의 해당 path -
일괄 투입 금지: 모든 요구사항·모든 OpenAPI를 매 프롬프트마다 붙여넣지 말 것 -
추측 금지: open-items / UNRESOLVED를 통해 사양을 확정 짓지 않도록 주의 -
스킬 vs 정본: 스킬은 워크플로우. 사양의 정본은 REQ / OpenAPI -
세션 경계: AGENTS.md·스킬 업데이트 후에는 새 채팅 권장
## 에이전트에게 전달하는 순서
1. AGENTS.md
2. docs/requirements/REQ-042.md 만
...
| 정보 분류 | AI 투입 가능 여부 | 조건 |
|---|---|---|
| 공개 정보 | 가능 | 출처를 남길 것 |
| ... |
[!warning] 정보 분류로 판단
편리함이 아니라 정보 분류로 판단한다. 망설여질 경우에는 투입하지 말고, 익명화 또는 사내 승인을 먼저 진행한다.
| 파일 | 용도 |
|---|---|
AGENTS.md | PG·에이전트의 입구 |
| GitHub PR #128 | docs / OpenAPI / 테스트 동봉 예시 |
.github/pull_request_template.md | PR 템플릿 |
src/orders/ | Vertical Slice 구성 |
AI 자동 생성 콘텐츠
본 콘텐츠는 Qiita AI의 원문을 AI가 자동으로 요약·번역·분석한 것입니다. 원 저작권은 원저작자에게 있으며, 정확한 내용은 반드시 원문을 확인해 주세요.
원문 바로가기