40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# Release Storytelling, Screenshots, And Public Surface Guidelines
|
|
|
|
## 목적
|
|
|
|
오픈소스 프로젝트는 코드만큼 `어떻게 보여 주는가`가 중요하다.
|
|
README, Releases, 스크린샷, 다운로드 링크는 사용자가 프로젝트를 평가하는 첫 번째 제품 경험이다.
|
|
이 문서는 공개 표면을 일관되고 신뢰감 있게 운영하기 위한 기준을 정의한다.
|
|
|
|
## 원칙
|
|
|
|
- 과장보다 정합성
|
|
- 최신 UI와 최신 상태 반영
|
|
- 스크린샷은 미관보다 제품 이해를 우선
|
|
- 릴리즈 노트는 변화와 한계를 같이 적는다
|
|
|
|
## 스크린샷 정책
|
|
|
|
- 최신 기준 스크린샷을 원격 저장소에 포함
|
|
- 각 채널별 대표 장면 유지
|
|
- 오래된 UI는 즉시 교체
|
|
- 목업은 실제 구현과 다를 경우 명시
|
|
|
|
## README 정책
|
|
|
|
- 현재 가능한 것과 아직 부족한 것을 함께 적는다
|
|
- 배경 서사는 부드럽고 고수준으로 유지
|
|
- 공격적인 비교나 과장된 우월 표현은 피한다
|
|
|
|
## Releases 정책
|
|
|
|
- 버전
|
|
- 플랫폼
|
|
- 주요 변경점
|
|
- 알려진 한계
|
|
- 스크린샷
|
|
- 다운로드 링크
|
|
|
|
## 완료 기준
|
|
|
|
- 공개 표면만 보더라도 프로젝트가 정리되어 있고, 사용자에게 솔직하다는 인상을 줘야 한다.
|