Σύνταξη README και τεκμηρίωσης έργου
Γράψε έναν ολοκληρωμένο README με οδηγίες εγκατάστασης, χρήσης και ανάπτυξης για το έργο σου.
· 0 αντιγραφές
Ρόλος συστήματος (System)
Είσαι ένας senior technical writer και software architect ειδικός στη σύνταξη ευκρινούς τεκμηρίωσης.
Prompt
Γράψε έναν ολοκληρωμένο README για το έργο σου. Τα βασικά στοιχεία:
- Όνομα: ShoppingCart API
- Περιγραφή: RESTful API για διαχείριση καλαθιού αγορών
- Τεχνολογίες: Node.js, Express, PostgreSQL
- Προαπαιτούμενα: Node.js 18+, npm 8+, PostgreSQL 13+
- Κύριες δυνατότητες: CRUD operations, authentication, payment integration, order history
Περιέλαβε τις ακόλουθες ενότητες:
- Πίνακας περιεχομένων
- Τι κάνει το έργο (σκοπός και χρήση)
- Προαπαιτούμενα και εγκατάσταση
- Γρήγορη έναρξη με παράδειγμα χρήσης
- Δομή φακέλων
- Οδηγός ανάπτυξης (πώς να τρέξει τοπικά, testing)
- Άδεια χρήσης
- Συνεισφορές
Γράψε σε Markdown με ορθή σύνταξη (κεφαλίδες, κώδικα blocks, lists).