vuralserhat86

docs_readme

README best practices ve proje dokümantasyon şablonları.

vuralserhat86 43 12 Updated 5mo ago
GitHub

Install

npx skillscat add vuralserhat86/antigravity-agentic-skills/docs-readme

Install via the SkillsCat registry.

SKILL.md

📄 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

![Build](https://img.shields.io/badge/build-passing-green)
![Coverage](https://img.shields.io/badge/coverage-95%25-green)

Docs README v1.1 - Enhanced

🔄 Workflow

Kaynak: Awesome README

Aşama 1: First Impression

  • Hero: Proje ismi, kısa açıklama ve mümkünse logo/banner ekle.
  • Badges: CI/CD durumu, lisans ve versiyon badge'lerini en üste koy.
  • Demo: Canlı demo linki veya GIF/Screenshot ekle.

Aşama 2: Content Structure

  • Installation: Tek satırlık kurulum komutu (npm install ...).
  • Usage: En yaygın kullanım senaryosu için kod örneği.
  • Contributing: Katkı sağlama rehberine link (CONTRIBUTING.md).

Aşama 3: Maintenance

  • Links: Kırık link kontrolü yap (Link Checker).
  • License: LICENSE dosyası ile README'deki lisans beyanı tutarlı mı?
  • Update: Her major release sonrası README'yi güncelle.

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?