File contents 📄 Docs README
README ve proje dokümantasyonu best practices.
📋 README Template
# Project Name
> Tek cümleyle projenin ne yaptığını açıkla.
## Features
- ✅ Feature 1
- ✅ Feature 2
## Quick Start
### Prerequisites
- Node.js 20+
### Installation
npm install && npm run dev
## Documentation
- [API Reference](./docs/api.md)
- [Contributing](./CONTRIBUTING.md)
## License
MIT
📝 README Kuralları
Kural
Açıklama
Başlık açık
Ne olduğu hemen anlaşılmalı
Quick start kısa
5 dakikada çalıştırabilmeli
Copy-paste ready
Kod blokları doğrudan çalışmalı
Görsel kullan
Badge, screenshot, diagram
📊 Badges
Docs README v1.1 - Enhanced
🔄 Workflow
Kaynak: Awesome README
Aşama 1: First Impression
Aşama 2: Content Structure
Aşama 3: Maintenance
Kontrol Noktaları
Aşama
Doğrulama
1
Okuyucu projenin ne işe yaradığını 5 saniyede anlıyor mu?
2
Kurulum komutları "copy-paste" ile hatasız çalışıyor mu?
3
Görseller optimize edilmiş (hafif) ve yükleniyor mu?
1 --- 2 name: docs-readme 3 description: 📄 Docs README 4 --- 5 6 # 📄 Docs README 7 8 > README ve proje dokümantasyonu best practices. 9 10 --- 11 12 ## 📋 README Template 13 14 ```markdown 15 # Project Name 16 17 > Tek cümleyle projenin ne yaptığını açıkla. 18 19 ## Features 20 - ✅ Feature 1 21 - ✅ Feature 2 22 23 ## Quick Start 24 25 ### Prerequisites 26 - Node.js 20+ 27 28 ### Installation 29 npm install && npm run dev 30 31 ## Documentation 32 - [API Reference](./docs/api.md) 33 - [Contributing](./CONTRIBUTING.md) 34 35 ## License 36 MIT 37 ``` 38 39 --- 40 41 ## 📝 README Kuralları 42 43 | Kural | Açıklama | 44 |-------|----------| 45 | Başlık açık | Ne olduğu hemen anlaşılmalı | 46 | Quick start kısa | 5 dakikada çalıştırabilmeli | 47 | Copy-paste ready | Kod blokları doğrudan çalışmalı | 48 | Görsel kullan | Badge, screenshot, diagram | 49 50 --- 51 52 ## 📊 Badges 53 54 ```markdown 55  56  57 ``` 58 59 --- 60 61 *Docs README v1.1 - Enhanced* 62 63 ## 🔄 Workflow 64 65 > **Kaynak:** [Awesome README](https://github.com/matiassingers/awesome-readme) 66 67 ### Aşama 1: First Impression 68 - [ ] **Hero**: Proje ismi, kısa açıklama ve mümkünse logo/banner ekle. 69 - [ ] **Badges**: CI/CD durumu, lisans ve versiyon badge'lerini en üste koy. 70 - [ ] **Demo**: Canlı demo linki veya GIF/Screenshot ekle. 71 72 ### Aşama 2: Content Structure 73 - [ ] **Installation**: Tek satırlık kurulum komutu (`npm install ...`). 74 - [ ] **Usage**: En yaygın kullanım senaryosu için kod örneği. 75 - [ ] **Contributing**: Katkı sağlama rehberine link (`CONTRIBUTING.md`). 76 77 ### Aşama 3: Maintenance 78 - [ ] **Links**: Kırık link kontrolü yap (Link Checker). 79 - [ ] **License**: LICENSE dosyası ile README'deki lisans beyanı tutarlı mı? 80 - [ ] **Update**: Her major release sonrası README'yi güncelle. 81 82 ### Kontrol Noktaları 83 | Aşama | Doğrulama | 84 |-------|-----------| 85 | 1 | Okuyucu projenin ne işe yaradığını 5 saniyede anlıyor mu? | 86 | 2 | Kurulum komutları "copy-paste" ile hatasız çalışıyor mu? | 87 | 3 | Görseller optimize edilmiş (hafif) ve yükleniyor mu? |
commit 559a64da9b
Frequently asked questions How do I install the Docs Readme skill? Run npx skillmds@latest add vuralserhat86/docs-readme in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
What does the Docs Readme skill do? 📄 Docs README It is listed under Coding & Dev Tools on SkillMD.
Is Docs Readme safe to use? This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
Which AI agents work with Docs Readme? This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Is Docs Readme free to use? Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
Who published Docs Readme? vuralserhat86 (@vuralserhat86) published this skill. Their other Agent Skills are listed on their SkillMD profile.
vuralserhat86