Agent skill · writing content · aiskillstore
readme-for-developers
Write developer-oriented README as onboarding documentation. Use when creating/updating README, setting up new projects, or when new developers need to understand the codebase quickly. README = Entry point + Architecture overview + Working agreement.
Why this skill is useful
Provides a structured template for developer onboarding that includes specific sections and guidelines not commonly found in generic documentation.
What it needs
About 4k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
README for Developers 개발자를 위한 README는 마케팅 문서가 아니라 '인계인수서'입니다. 이 문서 하나만 보고도 신규 개발자가 로컬 서버를 띄우고, 코드 흐름을 머릿속에 그릴 수 있어야 합니다. Core Principle "README = 지도, 디테일은 docs/로 링크" 정보를 한 파일에 다 넣지 말고, README가 전체 지도를 제공하고 세부는 링크로 내려가게 한다. README 품질 체크리스트 README만 읽고 새 개발자가 아래 질문에 답할 수 있으면 합격: [ ] 이 시스템의 목표/비목표는? [ ] 데이터는 어디에 저장되고, 핵심 식별자는? [ ] 핵심 플로우 2~3개는 어떻게 동작하는가? [ ] 엔트리포인트 파일 3개는 어디인가? [ ] 자주 터지는 버그의 관측 지점은? [ ] CI는 무엇을 어떤 순서로 강제하는가? [ ] 배포/롤백은 어떻게 하는가? [ ] 로컬 실행 3단계는? --- 필수 섹션 구조 0) New Engineer Fast Path (30분 코스) 1) System at a glance 2) Core Flows (핵심 동작 2~3개) 3) Repo Map (폴더 구조) 4) Local Dev (로컬 개발) 5) Configuration & Secrets 6) Data Model / Storage 7) CI/CD & Release 8) Debugging & Observability 9) Security 10) Working Agreement 11) Docs Index --- Mermaid 아키텍처 예시 --- Anti-patterns Workflow 1. 프로젝트 분석 2. README 초안 작성 위 11개 섹션 구조에 맞춰 작성 3. 체크리스트 검증 신규 개발자 관점에서 8개 질문에 답할 수 있는지 확인 --- References Diátaxis Documentation Framework The Good Docs Project GitHub Developer Onboarding
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/readme-for-developers