Към всички skills

adr-log

aiskillstore · Документация

Document architecture decisions with ADR (Architecture Decision Records). Use when making significant technical decisions, choosing between alternatives, or when onboarding needs context on past decisions.

Оригинален текст · няма потвърден превод на български

Първо прочетете инструкцията.

Файлът се зарежда от посочения източник само по ваше действие. Можете да го прочетете тук, да го копирате или да го запазите като .md.

Оригинален SKILL.md
GitHub хранилище
Звезди на репото
428
Лиценз
Не е посочен. Проверете в репозитория.
Последна проверка на записа
Няма посочена дата

Добавете в своя инструмент.

Командата отваря избора на skills от репозитория. Прочетете файла и условията на автора преди изпълнение.

npx skills add aiskillstore/marketplace

Страницата копира текст. Не инсталира и не изпълнява нищо на устройството ви.

Откъс от SKILL.md

Началото на файла на автора, без превод.

ADR (Architecture Decision Records)

아키텍처 결정을 문서화하여 "왜 그렇게 했는지"를 기록하는 스킬입니다.

Core Principle

"결정의 '무엇'보다 '왜'가 중요하다." "6개월 후의 나도 알아볼 수 있게 기록한다."

ADR이 필요한 경우

상황예시
기술 선택React vs Vue, PostgreSQL vs MongoDB
아키텍처 패턴Monolith vs Microservices
의존성 추가새 라이브러리 도입
보안 결정인증 방식 선택
성능 트레이드오프캐싱 전략 결정
표준 변경코딩 컨벤션 변경

ADR 폴더 구조

docs/
└── adr/
    ├── 0000-adr-template.md
    ├── 0001-use-nextjs-app-router.md
    ├── 0002-choose-postgresql-over-mongodb.md
    ├── 0003-implement-jwt-authentication.md
    └── README.md

ADR 템플릿

docs/adr/0000-adr-template.md

# [번호]. [결정 제목]

날짜: YYYY-MM-DD

## 상태

[Proposed | Accepted | Deprecated | Superseded by ADR-XXXX]

## 컨텍스트

이 결정이 필요한 배경/문제 상황을 설명합니다.

- 현재 상황은 무엇인가?
- 어떤 문제를 해결하려 하는가?
- 어떤 제약 조건이 있는가?

## 결정

우리는 [X]를 선택했다.

### 고려한 대안들

1. **대안 A**: [설명]
   - 장점: ...
   - 단점: ...

2. **대안 B**: [설명]
   - 장점: ...
   - 단점: ...

3. **선택: 대안 C**: [설명]
   - 장점: ...
   - 단점: ...

## 결과

### 긍정적 영향
- ...

### 부정적 영향
- ...

### 리스크
- ...

## 참고 자료

- [링크1]
- [링크2]

실제 ADR 예시

docs/adr/0001-use-nextjs-app-router.md

# 1. Next.js App Router 사용

날짜: 2024-01-15

## 상태

Accepted

## 컨텍스트

새 프로젝트의 프론트엔드 프레임워크를 선택해야 한다.

요구사항:
- SEO 최적화 필요 (마케팅 페이지)
- 빠른 초기 로딩
- 팀의 React 경험 활용
- 서버 사이드 데이터 페칭

## 결정

**Next.js 14 App Router**를 선택한다.

### 고려한 대안들

1. **Next.js Pages Router**
   - 장점: 안정적, 레퍼런스 많음
   - 단점: 레거시화 진행 중, 새 기능 제한적

2. **Remix**
   - 장점: 뛰어난 데이터 로딩, 프로그레시브 향상
   - 단점: 팀 학습 비용, 상대적으로 작은 생태계

3. **선택: Next.js App Router**
   - 장점: React Server Components, 향상된 캐싱, Vercel 최적화
   - 단점: 일부 라이브러리 호환성 이슈, 학습 곡선

## 결과

### 긍정적 영향
- React Server Components로 번들 크기 감소
- 레이아웃 중첩으로 코드 재사용성 향상
- Vercel 배포 최적화

### 부정적 영향
- 일부 클라이언트 전용 라이브러리 사용 시 'use client' 필요
- Pages Router 경험자의 학습 필요

### 리스크
- App Router의 상대적인 신규성 (안정성 확인 필요)
- 일부 third-party 라이브러리 호환성

## 참고 자료

- [Next.js App Router Docs](https://nextjs.org/docs/app)
- [Server Components RFC](https://github.com/reactjs/rfcs/pull/188)

docs/adr/0002-choose-postgresql-over-mongodb.md

Целият SKILL.md в GitHub