readme-writing
README 작성 가이드
이 스킬은 프로젝트의 README.md 파일을 작성하거나 업데이트할 때 사용합니다. 아래의 작성 규칙과 템플릿을 엄격히 준수하십시오.
작성 규칙
핵심 원칙
- 사실 기반 작성: 모든
{placeholder}는 실제 프로젝트 파일/폴더/코드/설정에서 추출한 정보로 채운다. - 허구 금지: 존재하지 않는 파일, 폴더, 환경변수, 기능을 생성하거나 언급하지 않는다.
- 간결성: 불필요한 형용사 없이 명확하고 간결하게 작성한다.
- 한국어 우선: 고유명사(기술명, 라이브러리명 등)를 제외한 모든 내용은 한국어로 작성한다.
섹션 선택 기준
| 섹션 | 필수 | 포함 조건 |
|---|---|---|
| Overview | ✅ | 항상 포함 |
| Tech Stack | ✅ | 항상 포함 |
More from datamktkorea/agent-skills
git-commit
A skill for writing Git commit messages. It follows rules combining Conventional Commits and Gitmoji to maintain a consistent commit history.
12git-pull-request
This skill is used by the AI agent to automatically generate Pull Request (PR) content by analyzing Git commit logs and branch strategies. It activates when the user requests to "Create a PR," "Summarize changes," or specifies a commit range for documentation.
9fastapi-best-practices
A skill for following best practices when developing FastAPI applications. It covers guidelines for project structure, code organization, and common patterns to ensure maintainable and scalable FastAPI projects.
3react-state-orchestration
Clean architecture patterns for TanStack Query v5 + Zustand 5 in React/Next.js applications. Use this skill when writing, reviewing, or refactoring state management code — especially when touching server data fetching, Zustand stores, or async mutations. Triggers on tasks involving React Query hooks, Zustand selectors, optimistic updates, or cache management.
2write-meeting-notes
Writes structured meeting notes for team meetings. Use this skill whenever the user provides meeting content — a transcript, script, audio file path, or rough notes — and wants it turned into a proper meeting record. Trigger on phrases like "회의록 써줘", "미팅 노트 정리해줘", "회의 내용 정리", "write meeting notes", or when a user pastes a meeting transcript and says "이거 회의록으로 만들어줘". Also trigger when the user shares a meeting recording or file and asks to summarize or document it.
1