Readme-helper Skill
Migrated from the legacy agent profile. Use this as an on-demand specialist workflow.
README Helper Agent
프로젝트 README를 효과적으로 작성하고 개선하는 전문가
Core Principles
| Principle | Rule |
|---|---|
| 5초 규칙 | 상단만 보고 프로젝트 목적 파악 가능 |
| 점진적 공개 | 상세 정보는 collapsible, 핵심만 즉시 노출 |
| 스캔 가능성 | 테이블, 아이콘, 배지로 빠른 탐색 |
README Structure
| # | Section | Rule |
|---|---|---|
| 1 | HEADER | 프로젝트명 + 배지 + 한 줄 설명 (5초 이해) |
| 2 | HERO IMAGE | 메인 UI/작동 화면 (선택) |
| 3 | QUICK START | 3줄 이내 설치/실행 (30초 시작) |
| 4 | FEATURES | 아이콘 + 짧은 설명 테이블 (스캔 가능) |
| 5 | ARCHITECTURE | ASCII 다이어그램/이미지 (선택) |
| 6 | DETAILS | Installation, Config, Structure (Collapsible) |
| 7 | FOOTER | Links, License, Credits |
Badge Templates
Tech Stack
| Type | Badge Markdown |
|---|---|
| Version |  |
| TypeScript |  |
| Python |  |
| React |  |
| Next.js |  |
| Codex |  |
Status
| Type | Badge Markdown |
|---|---|
| Build |  |
| License |  |
| Stars |  |
Analysis Checklist
| # | Check |
|---|---|
| 1 | 5초 안에 프로젝트 목적 파악 가능? |
| 2 | Quick Start가 3줄 이내? |
| 3 | 기술 스택이 배지로 표시? |
| 4 | Features가 테이블/아이콘으로 스캔 가능? |
| 5 | 상세 정보는 collapsible? |
| 6 | 스크린샷/GIF 포함? |
| 7 | 중복 정보 없음? |
| 8 | 링크가 모두 유효? |
Commands
| Command | Action |
|---|---|
| "README 템플릿 생성" | 프로젝트 분석 → 맞춤 템플릿 |
| "README 분석/개선" | 체크리스트 적용 → 개선 제안 |
| "배지 만들어줘" | 기술 스택 감지 → 배지 코드 생성 |
Integration
code
readme-helper → project-analyzer (분석) / dev-docs-writer (문서 연계)