원칙, 제약 조건 및 표준을 사용하여 헌법 만들기
헌법은 GitHub 사양 키트를 사용한 사양 기반 개발의 기초입니다. 이 단원에서는 엔터프라이즈 개발 시나리오에 대한 효과적인 헌법을 만드는 방법을 살펴봅니다.
헌법 기본 사항 검토
헌법 파일은 프로젝트를 관리하는 협상할 수 없는 원칙, 제약 조건 및 표준을 캡처합니다. 또한 AI 지원 개발을 위한 가드레일 역할을 합니다. 에이전트가 사양, 계획, 작업 또는 코드를 생성할 때 제안서가 표준을 준수하는지 확인하기 위해 헌법을 참조합니다.
잘 정의된 헌법의 주요 이점은 다음과 같습니다.
- 일관성 적용: 긴 프로젝트 및 여러 개발자의 아키텍처 결정과 일치하도록 보장합니다.
- 규정 준수 설명서: 규정 요구 사항 및 보안 정책을 명시적이고 감사 가능하게 만듭니다.
- 기관 지식 캡처: AI 코드 생성을 안내하는 형식으로 값진 경험을 보존합니다.
- 인지 부하 감소: 개발 중에 조직 정책 적용을 자동화합니다.
헌법의 목적
잘 정의된 헌법의 이점은 자동 시행을 통해 실제로 강력해집니다. 헌법에 "모든 데이터를 미사용 시 암호화해야 한다"고 명시되어 있는 경우 AI 에이전트는 파일을 일반 텍스트로 저장하는 것을 제안하지 않으며, 자동으로 암호화를 디자인에 통합합니다. 파일 업로드에 대한 사양을 생성할 때 계획에는 Azure Storage 암호화 구성이 포함됩니다. 코드를 생성할 때 구현은 암호화된 스토리지 서비스를 사용합니다.
실제 개발 시나리오에서 각 혜택이 어떻게 나타나는지 고려합니다.
일관성 적용: 수개월에 걸친 프로젝트 또는 여러 개발자가 참여하는 프로젝트는 아키텍처 결정에서 멀어지게 될 수 있습니다. 헌법이 없으면 한 개발자가 로컬 파일 스토리지를 사용하고 다른 개발자는 유사한 기능에 Azure Blob Storage를 사용할 수 있습니다. 헌법은 AI 도우미가 항상 참조하는 표준을 인코딩하여 이러한 드리프트를 방지하여 모든 기능에서 균일한 기술 선택을 보장합니다.
규정 준수 설명서: 규정 요구 사항, 보안 정책 및 내부 거버넌스 규칙을 따라야 합니다. 헌법은 규정 준수를 적용하는 방법에 대한 감사 가능한 레코드를 만들어 요구 사항을 명시합니다. 감사자가 "개인 데이터가 기록되지 않도록 하려면 어떻게 해야 합니까?"라고 묻으면 헌법 요구 사항을 가리키고 생성된 모든 코드가 이 제약 조건을 준수한다는 것을 보여 줍니다.
기관 지식 캡처: 숙련된 설계자 및 보안 팀은 특정 API 패턴이 성능 문제를 일으키거나 특정 인증 흐름이 보안 취약성을 발생시키는 것을 검색하는 것과 같이 어려운 교훈을 기반으로 결정을 내립니다. 헌법은 AI 코드 생성을 안내하는 형태로 이러한 지혜를 보존하여 새 팀원이 동일한 제약 조건을 반복적으로 다시 검색하지 못하도록 합니다.
인지 부하 감소: 개발자는 AI를 요청하는 동안 모든 조직 표준을 기억할 필요가 없습니다. 헌법은 "비밀에 Azure Key Vault 사용" 또는 "Microsoft Entra ID를 통해 인증"와 같은 정책의 적용을 자동화합니다. AI는 생성된 각 계획을 요구 사항 검사 목록에 대해 수동으로 확인하는 대신 자동으로 통합합니다.
엔터프라이즈 개발 환경에서 헌법은 종종 다음을 인코딩합니다.
- 회사 정책에서 요구하는 보안 요구 사항
- 엔터프라이즈 워크로드의 성능 및 확장성 목표입니다.
- Azure 서비스 및 내부 도구와 일치하는 기술 선택
- 엔지니어링 모범 사례의 코딩 표준 및 아키텍처 패턴
- 접근성 표준, 개인 데이터 보호 및 감사 요구 사항과 같은 규정 준수 의무
효과적인 헌법의 구조
잘 구성된 헌법은 AI 도우미가 쉽게 참조할 수 있는 범주로 원칙을 구성합니다.
일반적인 섹션은 다음과 같습니다.
- 기술 표준.
- 보안 요구 사항.
- 성능 및 확장성.
- 코딩 표준.
- 규정 준수 및 거버넌스.
다음 섹션에서는 각 범주를 효과적으로 정의하는 방법을 보여 줍니다.
기술 표준
기술 표준은 승인된 기술, 플랫폼 및 프레임워크를 지정하는 데 사용됩니다.
예를 들어 다음 섹션에서는 백 엔드 개발을 위해 Azure 서비스 및 .NET을 요구합니다.
## Technology Standards
- All cloud resources must be hosted on Microsoft Azure.
- Back-end services use .NET 8 or later.
- Front-end applications use React or Blazor.
- Database: Azure SQL Database or Cosmos DB (no on-premises SQL Server).
- Secret management exclusively via Azure Key Vault.
이러한 제약 조건은 AI가 호환되지 않는 기술을 제안하지 못하게 합니다. 헌법이 Azure를 의무화하는 경우 GitHub Copilot는 Amazon Web Services Lambda 함수를 제안하지 않습니다.
보안 요구 사항
보안 요구 사항은 인증, 권한 부여, 암호화 및 데이터 보호 규칙과 같은 항목을 정의하는 데 사용할 수 있습니다.
예를 들어 다음 섹션에서는 내부 애플리케이션에 대한 보안 원칙을 설정합니다.
## Security Requirements
- Authenticate all API requests using Microsoft Entra ID tokens.
- Encrypt all data at rest using AES-256 encryption.
- Encrypt data in transit using TLS 1.2 or higher.
- Never log personally identifiable information (PII).
- Store no secrets in source code or configuration files.
- Implement role-based access control (RBAC) for all features.
보안 원칙은 엔터프라이즈 개발에 매우 중요합니다. 명시적 요구 사항은 생성된 코드가 처음부터 보안을 통합하도록 합니다.
성능 및 확장성
성능 및 확장성 요구 사항은 로드 중인 시스템 동작에 대한 기대치를 설정하는 데 사용됩니다.
예를 들어 다음 섹션에서는 API에 대한 성능 대상을 정의합니다.
## Performance and Scalability
- APIs must respond within 200ms for 95th percentile requests.
- System must handle 10,000 concurrent users.
- Use asynchronous processing for operations exceeding 5 seconds.
- Implement caching for frequently accessed data.
- Design for horizontal scalability using Azure App Service or Container Apps.
성능 요구 사항은 아키텍처 결정을 안내합니다. 헌법에서 대용량 파일 업로드를 비동기적으로 처리해야 하는 경우 이 계획은 백그라운드 처리를 통합합니다.
코드 표준 및 지침
표준 및 지침은 코드 품질을 보장하는 데 도움이 되는 요구 사항을 제공합니다.
예를 들어 다음 섹션에서는 .NET 프로젝트에 대한 코딩 규칙을 간략하게 설명합니다.
## Coding Standards
- Follow Microsoft C# Coding Conventions.
- Maintain minimum 80% unit test coverage.
- All public APIs documented with XML comments.
- Use dependency injection for service dependencies.
- Implement structured logging using ILogger interface.
코딩 표준은 코드베이스 전체에서 일관성을 보장합니다. AI 생성 코드는 규약에서 참조할 때 팀 관례에 부합합니다.
규정 준수 및 거버넌스
규정 준수 및 거버넌스 요구 사항은 규정 및 내부 정책 요구 사항을 문서화하는 데 사용됩니다.
예를 들어 다음 섹션에서는 데이터 처리에 대한 규정 준수 원칙을 캡처합니다.
## Compliance and Governance
- Comply with local and international standards that protect personal information for all user data processing.
- Implement audit logging for all data modifications.
- Support accessibility standards (WCAG 2.1 Level AA).
- Enable monitoring and alerting via Azure Application Insights.
- Retain logs for minimum 90 days for compliance audits.
규정 준수 원칙은 규정 위반으로부터 조직을 보호합니다. 헌법은 이러한 원칙이 개발 중에 잊혀지지 않도록 보장합니다.
GitHub 사양 키트를 사용하여 헌법 만들기
GitHub 사양 키트의 /speckit.constitution 명령을 사용하여 헌법 파일을 만들거나 업데이트할 수 있습니다.
기존 프로젝트
이미 헌법 파일이 포함된 기존 프로젝트를 작업하는 경우 명령을 사용하여 /speckit.constitution 헌법을 업데이트할 수 있습니다. GitHub Copilot는 기존 헌법을 검토하고 코드베이스를 기반으로 업데이트를 제안합니다. GitHub 사양 키트 자체에 대한 업데이트는 제안된 변경 내용에도 반영될 수 있습니다.
아직 헌법이 없는 기존 프로젝트에 GitHub Spec Kit를 추가하는 경우 GitHub Copilot Chat의 명령을 사용하여 /speckit.constitution 생성할 수 있습니다. GitHub Copilot는 기존 코드베이스를 검토하고 프로젝트 원칙 및 제약 조건을 유추하여 초기 constitution.md 파일을 만듭니다. 필요한 경우 생성된 헌법을 구체화하여 프로젝트의 요구 사항을 정확하게 반영할 수 있습니다.
새 프로젝트
GitHub Spec Kit를 사용하여 새 프로젝트를 시작할 때 GitHub Copilot Chat의 /speckit.constitution 명령을 사용하여 처음부터 헌법을 생성할 수 있습니다.
새 프로젝트에 대한 헌법을 만들려면 다음을 수행합니다.
Visual Studio Code에서 프로젝트를 열고 GitHub 사양 키트가 초기화되었는지 확인합니다.
GitHub Copilot 채팅을 연 다음 프로젝트 원칙 및 제약 조건에 대한 자연어 설명과 함께 명령을 실행
/speckit.constitution합니다.예를 들어 다음 프롬프트를 제공할 수 있습니다.
/speckit.constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements. Include governance for how these principles should guide technical decisions and implementation choices.GitHub Copilot는 범주별로 구성된 섹션을 사용하여 구조화된
constitution.md파일을 생성합니다.
생성된 헌법 구체화
GitHub Copilot가 초기 헌법을 생성한 후 이를 검토하고 편집하여 정확성을 보장합니다.
또한 다음 단계도 고려합니다.
누락된 원칙 추가: GitHub Copilot에서 중요한 요구 사항을 생략한 경우 수동으로 추가합니다. 예를 들어 조직에 특정 로깅 형식이 필요한 경우 해당 제약 조건을 추가합니다.
불필요한 콘텐츠 제거: GitHub Copilot는 상용구 또는 지나치게 일반적인 원칙을 생성할 수 있습니다. 구체적인 지침을 제공하지 않는 모든 항목을 삭제합니다.
원칙을 구체적이고 테스트 가능하게 만듭니다. 모호한 문을 측정 가능한 조건으로 바꿉니다. "시스템은 빠르다"를 "95%의 요청이 200 ms 이내에 완료되는 API 응답으로" 변경합니다.
내부 표준에 맞게 조정: 가능하면 기존 문서를 참조합니다. 예: "API 디자인에 대한 엔지니어링 우수 지침 v2.3을 따르세요."
관련자와 확인: 보안, 규정 준수 및 아키텍처 팀과 헌법을 공유하여 필요한 모든 요구 사항을 캡처했는지 확인합니다.
헌법은 살아있는 문서이지만 자주 변경되지 않습니다. 일단 설정되면 기능 개발 전반에 걸쳐 안정적인 지침을 제공합니다.
사양 기반 개발 워크플로의 기본 원칙
헌법을 만든 후 GitHub 사양 키트는 후속 워크플로 단계에서 자동으로 참조합니다.
사양 단계: 기능 사양을 만들기 위해 실행하는
/speckit.specify경우 GitHub Copilot는 헌법을 검사하여 요구 사항이 기존 원칙을 위반하지 않도록 합니다. 사양이 파일을 로컬에 저장하도록 제안할 경우, GitHub Copilot는 이것이 헌법의 Azure Blob Storage 의무와 충돌한다고 지적합니다.계획 단계: 이
/speckit.plan명령은 헌법 요구 사항 준수를 명시적으로 확인하는 기술 계획을 생성합니다. 계획에는 디자인이 각 관련 원칙을 충족하는 방법을 보여 주는 섹션이 포함되어 있습니다.분석 단계: 실행 과정에서
/speckit.analyze사양, 계획, 작업을 규정과 비교하여 불일치를 식별합니다. 예를 들어 작업에 사용자 이름/암호 인증 구현이 포함되어 있지만 헌법에 Microsoft Entra ID가 필요한 경우 분석에서 이 편차를 파악합니다.구현 단계: 코드를
/speckit.implement생성할 때 GitHub Copilot는 헌법 제약 조건을 적용하는 구현을 생성합니다. 코드는 헌법에 의해 위임된 경우 Microsoft Entra ID 인증을 자동으로 포함합니다.
이러한 통합은 헌법이 매우 강력한 이유입니다. 원칙을 한 번 작성하고 AI는 개발 전반에 걸쳐 자동으로 적용합니다.
엔터프라이즈별 헌법 고려 사항
엔터프라이즈 내부 프로젝트에 대한 헌법을 만들 때 다음과 같은 일반적인 요구 사항을 통합합니다.
Azure 우선 아키텍처: 호스팅, 스토리지, 데이터베이스 및 지원 인프라에 대한 Azure 서비스를 위임합니다. 이 요구 사항은 회사 클라우드 전략 및 사용 가능한 도구와 일치합니다.
엔터프라이즈 인증: 인증을 위해 Microsoft Entra ID가 필요하고 권한 부여를 위해 RBAC가 필요합니다. 대부분의 엔터프라이즈 내부 앱은 회사 ID 시스템과 통합됩니다.
보안 및 규정 준수: 엔터프라이즈 보안 정책, TrustWorthy 컴퓨팅 원칙 및 적용 가능한 규정 준수 프레임워크를 참조합니다.
모니터링 및 관찰 가능성: Azure 애플리케이션 Insights 또는 동등한 모니터링 솔루션을 위임합니다. 엔터프라이즈 애플리케이션은 프로덕션 지원을 위한 포괄적인 원격 분석이 필요합니다.
개발자 도구 표준: 승인된 프레임워크, 라이브러리 및 개발 사례를 지정합니다. 예를 들어 내부 피드에서 승인된 NuGet 패키지를 사용해야 합니다.
접근성: WCAG 2.1 수준 AA 준수 요구 사항을 포함합니다. 엔터프라이즈 내부 도구는 장애가 있는 직원이 액세스할 수 있어야 합니다.
엔터프라이즈 내부 헌법 코드 조각 예제:
# Employee Portal Constitution
## Azure Platform Standards
- Host all services on Azure App Service or Azure Container Apps.
- Use Azure Blob Storage for document storage.
- Database: Azure SQL Database or Cosmos DB.
- Secrets stored exclusively in Azure Key Vault.
- Use Azure Front Door for global distribution.
## Identity Integration
- Authenticate via Microsoft Entra ID using OAuth 2.0 / OpenID Connect.
- Implement role-based access control using Microsoft Entra ID groups.
- Support multi-factor authentication (MFA).
- No custom authentication or local user databases.
## Corporate Compliance
- Follow enterprise Security Development Lifecycle (SDL) practices.
- Scan all dependencies for known vulnerabilities.
- Implement audit logging per enterprise retention policies.
- Support data residency requirements for EU users.
- Accessibility: WCAG 2.1 Level AA minimum.
## Development Standards
- Back end: .NET 10 following coding conventions adopted by the organization.
- Use approved packages from internal NuGet feed.
- Minimum 80% code coverage with unit tests.
- All APIs documented with OpenAPI/Swagger.
- Structured logging using ILogger interface.
헌법에서 이러한 원칙을 미리 설정하여 직원 포털용으로 빌드된 모든 기능이 엔터프라이즈 엔지니어링 표준, 보안 요구 사항 및 아키텍처 패턴에 자동으로 부합하도록 합니다. 헌법은 조직 지식을 AI 지원 개발을 안내하는 실행 가능한 제약 조건으로 변환합니다.
요약
헌법 파일은 GitHub 사양 키트를 사용한 사양 기반 개발에서 중요한 아티팩트입니다. 모든 개발 단계를 제어하는 변경할 수 없는 프로젝트 원칙, 제약 조건 및 표준을 캡처합니다. 이러한 요구 사항을 미리 정의하면 GitHub Copilot가 사양, 계획, 분석 및 구현 전반에 걸쳐 규정 준수를 자동으로 적용할 수 있습니다.