Kord/.agents/workflows/documentation.md

description
Documentation Workflow

이 워크플로우는 코드를 작성하거나 수정하기 전, 중, 후에 반드시 따라야 하는 문서화 규칙을 정의합니다. (Dcos는 올바른 Docs 디렉토리로 간주하여 작성되었습니다.)

핵심 원칙 (Core Principles)

1. 문서화 위치 (Location): 모든 문서는 반드시 <PROJECT_ROOT>/Docs/ 디렉토리 내에 작성되어야 합니다.
2. 사전 탐색 (Search First): 작업을 시작하기 전에 Docs/ 내의 관련 문서 유무를 먼저 탐색하고, 명시된 규칙/내용을 확인한 뒤 작업에 적용해야 합니다.

기록 대상 (What to Document)

프로젝트와 관련된 다음의 내용들은 반드시 문서화해야 합니다:

• 진행 및 완료한 작업 내역 (Work done)
• 중요한 기술적/기획적 의사 결정 사항 (Decisions made)
• 문제 해결 과정 및 트러블 슈팅 내역 (Troubleshooting)

색인 규칙 (Indexing Rules)

문서의 저장과 탐색을 원활하게 하기 위해 다음 규칙을 따릅니다:

1. 카테고리별 디렉토리 (Directory by Category): 문서는 카테고리별로 서브 디렉토리를 구성하여(예: Docs/Troubleshooting/, Docs/Decisions/ 등) 저장합니다.
2. index.md 색인화 (Indexing): 새로운 문서를 추가하거나 기존 문서를 변경하면, 반드시 Docs/index.md 파일에 해당 문서를 색인(링크 추가)하여 탐색을 용이하게 해야 합니다.

문서 기본 템플릿 (Basic Template)

모든 문서는 다음의 기본 구조를 포함해야 합니다.

• 체인지로그 (Changelog): 이 문서의 수정 내역 또는 관련 코드의 변경 이력 요약
• 본문 (Body): 상세 가이드, 문제 해결 과정, 의사 결정 배경 등 본 내용

금지 규칙 (Forbidden Rules)

문서를 작성할 때 절대 금지해야 하는 항목입니다:

• 중복 내용 (Duplicated Content): 다른 문서나 시스템에 이미 존재하는 내용을 반복해서 적지 마십시오.
• 없는 내용 (Fabricated Content): 근거가 없거나 실제로 이루어지지 않은 내용을 작성하지 마십시오.
• 향후 추가할 내용 (Placeholder Content): 아직 정해지지 않았거나 미완성인 내용을 "향후 추가 예정"이라고 적어두는 것을 금합니다. (이는 결국 의미 없는 껍데기 문서가 되므로 작성을 지양합니다.)