truthmark/docs/readmes/README.el.md

Truthmark

Οι πράκτορές σας γράφουν κώδικα. Το Truthmark διατηρεί την τεκμηρίωση για ανθρώπους, έτοιμη για έλεγχο στο Git.

Το Truthmark εγκαθιστά ροές εργασίας εγγενείς στο Git, ώστε οι πράκτορες προγραμματισμού AI να δημιουργούν νέα τεκμηρίωση προϊόντος και μηχανικής από υπάρχοντα κώδικα και tests, να τη διατηρούν ενημερωμένη μετά από κάθε αλλαγή κώδικα και να σας παραδίδουν συνηθισμένα Markdown diffs για έλεγχο.

Ξεκινήστε · Ιστότοπος · Οδηγός χρήστη · GitHub

Διαβάστε αυτό το README σε μία από 16 γλώσσες

🇺🇸 English | 🇨🇳 简体中文 | 🇯🇵 日本語 | 🇰🇷 한국어 | 🇩🇪 Deutsch | 🇫🇷 Français | 🇪🇸 Español | 🇧🇷 Português | 🇷🇺 Русский | 🇸🇦 العربية | 🇮🇹 Italiano | 🇵🇱 Polski | 🇹🇷 Türkçe | 🇻🇳 Tiếng Việt | 🇮🇩 Bahasa Indonesia | 🇬🇷 Ελληνικά

Δημιουργήστε την πρώτη τεκμηρίωση. Διατηρήστε την ακριβή.

Τα περισσότερα εργαλεία τεκμηρίωσης σταματούν μετά τη δημιουργία περιεχομένου. Το Truthmark προσφέρει στους πράκτορες έναν πλήρη κύκλο ζωής τεκμηρίωσης μέσα στο αποθετήριό σας:

• Δημιουργήστε νέα τεκμηρίωση από λογισμικό που λειτουργεί. Το Truth Document διαβάζει κώδικα και tests και έπειτα δημιουργεί τεκμηρίωση προϊόντος ή μηχανικής με σαφή όρια.
• Διατηρήστε αυτόματα ευθυγραμμισμένη την τεκμηρίωση. Το Truth Sync εκτελείται κατά την παράδοση του πράκτορα μετά από αλλαγές λειτουργικού κώδικα και ενημερώνει την αλήθεια του αποθετηρίου πριν ολοκληρωθεί η εργασία.
• Μετατρέψτε την τεκμηρίωση ξανά σε κώδικα. Το Truth Realize υλοποιεί εγκεκριμένα έγγραφα truth, διατηρώντας μια καθαρή ροή εργασίας doc-first.
• Αποκαταστήστε την ιδιοκτησία καθώς μεγαλώνει η βάση κώδικα. Το Truth Structure δημιουργεί διαδρομές με σαφή όρια και αρχικά έγγραφα για νέες ή υπερφορτωμένες περιοχές.
• Ελέγξτε τα πάντα στο Git. Κώδικας, αποφάσεις, συμβόλαια, αρχιτεκτονική, λειτουργίες και συμπεριφορά ταξιδεύουν μαζί με το branch.

Χωρίς φιλοξενούμενη βάση γνώσης. Χωρίς ιδιωτική μνήμη πράκτορα. Χωρίς τεκμηρίωση παγιδευμένη στο ιστορικό συνομιλιών.

Γρήγορη εκκίνηση: δημιουργήστε το πρώτο έγγραφο truth

Απαιτήσεις: Node.js 24 ή νεότερο, ένα αποθετήριο Git και ένας υποστηριζόμενος host προγραμματισμού AI για ροές εργασίας πρακτόρων.

Εκτελέστε τις παρακάτω εντολές μέσα στο αποθετήριο που θέλετε να διαχειρίζεται το Truthmark:

cd /path/to/your-repo
npm install -g truthmark
truthmark init

Το truthmark init σάς επιτρέπει να επιλέξετε Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, Cursor ή μια ρύθμιση διεπαφής γραμμής εντολών ανεξάρτητη από host.

Τώρα ζητήστε από τον διαμορφωμένο πράκτορά σας να τεκμηριώσει μία πραγματική συμπεριφορά:

/truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts

Το Truth Document δημιουργεί ένα νέο έγγραφο truth με σαφή όρια όταν δεν υπάρχει ήδη, ενημερώνει τον υπάρχοντα ιδιοκτήτη όταν υπάρχει και ενημερώνει τη δρομολόγηση όταν χρειάζεται. Δεν αλλάζει λειτουργικό κώδικα.

Ελέγξτε το αποτέλεσμα:

truthmark check
git status --short --untracked-files=all
git diff

Τώρα θα πρέπει να έχετε:

docs/truthmark/engineering/behaviors/session-timeout.md
docs/truthmark/routes/areas/authentication.md

Οι ακριβείς διαδρομές ακολουθούν τη δομή ιδιοκτησίας του αποθετηρίου σας. Τα νέα αρχεία εμφανίζονται στο git status και οι αλλαγές σε παρακολουθούμενα αρχεία στο git diff.

Ο τρόπος κλήσης διαφέρει ανά host. Το OpenCode χρησιμοποιεί /skill truthmark-document, το Antigravity χρησιμοποιεί @truthmark-document και οι άλλοι υποστηριζόμενοι hosts χρησιμοποιούν τη δική τους εγγενή επιφάνεια skill ή slash command. Δείτε τον πίνακα πλατφορμών για τις ακριβείς εντολές.

Για scripts και συνεχή ενοποίηση, δηλώστε ρητά τις επιλεγμένες πλατφόρμες:

truthmark init --platform codex --platform cursor
truthmark init --json

Επιλέξτε διαδραστικά none ή εκτελέστε truthmark init --clear-platforms για ένα αποθετήριο ανεξάρτητο από host. Μπορείτε να προσθέσετε πλατφόρμες πρακτόρων αργότερα, εκτελώντας ξανά το truthmark init.

Για διάγνωση ενημερότητας σε σχέση με το branch, δώστε μια βάση Git:

truthmark check --base <base-ref>

Πώς λειτουργεί το Truthmark

Η διεπαφή γραμμής εντολών του Truthmark εγκαθιστά και επικυρώνει το συμβόλαιο του αποθετηρίου. Ο πράκτορας προγραμματισμού σας εκτελεί την εξέταση αποδεικτικών στοιχείων και την εργασία τεκμηρίωσης μέσω των εγκατεστημένων, εγγενών ροών εργασίας του host.

Μια συνηθισμένη αλλαγή κώδικα ακολουθεί έναν απλό κύκλο:

1. Ο πράκτορας αλλάζει λειτουργικό κώδικα.
2. Εκτελούνται τα σχετικά tests.
3. Το Truth Sync ελέγχει τη χαρτογραφημένη τεκμηρίωση.
4. Ο πράκτορας δημιουργεί ή ενημερώνει τεκμηρίωση και δρομολόγηση όταν έχει αλλάξει η αλήθεια του αποθετηρίου.
5. Ελέγχετε μαζί το diff κώδικα και το diff truth.

Ροές εργασίας

Ροή εργασίας	Πότε χρησιμοποιείται	Αποτέλεσμα
Truth Document	Ο υπάρχων κώδικας χρειάζεται τεκμηρίωση	Δημιουργεί ή ενημερώνει τεκμηρίωση προϊόντος και μηχανικής που βασίζεται σε αποδεικτικά στοιχεία
Truth Sync	Άλλαξε λειτουργικός κώδικας	Διατηρεί ευθυγραμμισμένα τη χαρτογραφημένη τεκμηρίωση και τη δρομολόγηση πριν από την παράδοση
Truth Structure	Μια νέα περιοχή χρειάζεται ιδιοκτησία ή η υπάρχουσα τεκμηρίωση είναι υπερβολικά ευρεία	Δημιουργεί διαδρομές με σαφή όρια και σκελετικά αρχικά έγγραφα
Truth Realize	Ένα εγκεκριμένο έγγραφο truth πρέπει να γίνει λογισμικό που λειτουργεί	Ενημερώνει λειτουργικό κώδικα από την τεκμηρίωση
Truth Check	Η αλήθεια του αποθετηρίου χρειάζεται έλεγχο	Αναφέρει ζητήματα δρομολόγησης, ιδιοκτησίας, αποδεικτικών στοιχείων και τεκμηρίωσης
Truthmark Portal	Η ομάδα θέλει έναν εύχρηστο ιστότοπο τεκμηρίωσης	Δημιουργεί μια committed στατική παρουσίαση HTML από έγγραφα truth σε Markdown

Το Truthmark εγκαθιστά αυτές τις ροές εργασίας ως εγγενείς επιφάνειες αποθετηρίου για Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity και Cursor.

Τι αποκτάτε

Τεκμηρίωση που ξεκινά από την πραγματικότητα

Το Truthmark μπορεί να δημιουργήσει τεκμηρίωση για δυνατότητες προϊόντος, συμπεριφορά υλοποίησης, διεπαφές προγραμματισμού εφαρμογών, αρχιτεκτονική, ροές εργασίας, λειτουργίες και tests. Ο κώδικας και τα tests παρέχουν τα αποδεικτικά στοιχεία· τα έγγραφα Markdown με σαφή όρια διατηρούν το αποτέλεσμα.

Τεκμηρίωση που αντέχει στην επόμενη αλλαγή

Οι διαδρομές συνδέουν περιοχές κώδικα με κανονικά έγγραφα. Όταν οι πράκτορες αλλάζουν συμπεριφορά, το Truth Sync γνωρίζει πού ανήκει η αντίστοιχη αλήθεια και διατηρεί την παράδοση ελέγξιμη.

Αλήθεια προϊόντος και μηχανικής σε ξεχωριστές ροές

Η αλήθεια προϊόντος καταγράφει υποσχέσεις προς τους χρήστες, όρια, αποφάσεις και κριτήρια αποδοχής. Η αλήθεια μηχανικής καταγράφει την τρέχουσα συμπεριφορά, τα συμβόλαια, την αρχιτεκτονική, τις ροές εργασίας, τις λειτουργίες και τη συμπεριφορά των tests.

Συνεργασία εγγενής στο Git

Όλα τα σημαντικά στοιχεία βρίσκονται σε committed αρχεία του αποθετηρίου. Η αλήθεια ακολουθεί το branch, συνεργάζεται με συνηθισμένα pull requests και παραμένει ορατή σε κάθε συντηρητή και πράκτορα προγραμματισμού.

Τοπική λειτουργία κατά προτεραιότητα

Το Truthmark δεν χρειάζεται φιλοξενούμενη υπηρεσία, daemon, βάση δεδομένων, διανυσματική αποθήκη ή διακομιστή Model Context Protocol. Το αποθετήριο μεταφέρει τη δική του ροή εργασίας τεκμηρίωσης.

Πού ταιριάζει το Truthmark

Ανάγκη	Καλύτερη επιλογή
Καλύτερο αποτέλεσμα από μία συνεδρία πράκτορα	Καλύτερο prompt
Προσωπική συνέχεια ή συνέχεια σε επίπεδο συνεδρίας	Εργαλείο μνήμης
Εργασία σε λειτουργίες με πρώτο βήμα τον σχεδιασμό	Ροή εργασίας προδιαγραφών
Τεκμηρίωση με εύρος branch που ταξιδεύει μαζί με τον κώδικα	Truthmark
Ορθότητα συμπεριφοράς	Tests και έλεγχος κώδικα
Ελέγξιμη τεκμηρίωση με τη βοήθεια AI	Truthmark + έλεγχος στο Git

Το Truthmark έχει σχεδιαστεί για συντηρητές και ομάδες μηχανικής που χρησιμοποιούν ήδη πράκτορες προγραμματισμού AI και θέλουν το αποθετήριο να συνεχίζει να λέει την αλήθεια με την ίδια ταχύτητα που αλλάζει ο κώδικας.

Υποστηριζόμενοι hosts και γραμμή εντολών

Υποστηριζόμενοι hosts πρακτόρων:

• Codex
• Claude Code
• GitHub Copilot
• OpenCode
• Antigravity
• Cursor

Αναφορά γραμμής εντολών

Εντολή	Σκοπός
truthmark init	Δημιουργεί ή ανανεώνει τη διαμόρφωση, τη δρομολόγηση, τα πρότυπα και τις ροές εργασίας των επιλεγμένων hosts
truthmark check [--base <ref>]	Επικυρώνει την αλήθεια του αποθετηρίου και προαιρετικά εκτελεί διάγνωση ενημερότητας branch
truthmark index --json	Εξετάζει παράγωγα μεταδεδομένα αποθετηρίου και δρομολόγησης
truthmark impact --base <ref> --json	Χαρτογραφεί τα αλλαγμένα αρχεία σε τεκμηρίωση, ιδιοκτήτες και κοντινά tests
truthmark workflow status --workflow <id> [--base <ref>] --json	Εξετάζει τη δυνατότητα εφαρμογής και τους στόχους της ροής εργασίας
truthmark validate ...	Επικυρώνει αναφορές ροών εργασίας και άδειες εγγραφής
truthmark uninstall --dry-run|--apply	Προεπισκοπεί ή αφαιρεί τις παραγόμενες επιφάνειες host, διατηρώντας τα έγγραφα truth που έχουν συνταχθεί

Δομημένη έξοδος JSON είναι διαθέσιμη σε ολόκληρη τη διεπαφή γραμμής εντολών για scripts και συνεχή ενοποίηση.

Μάθετε περισσότερα

• Οδηγός χρήστη Truthmark
• Ευρετήριο τεκμηρίωσης
• Επισκόπηση αρχιτεκτονικής
• Συμβόλαια διαμόρφωσης, δρομολόγησης και εντολών
• Συντήρηση της αλήθειας του αποθετηρίου
• Συνεισφορά

Εγκαταστήστε το Truthmark, επιλέξτε τον host προγραμματισμού σας και μετατρέψτε σήμερα μία πραγματική συμπεριφορά σε τεκμηρίωση.

Άδεια

MIT. Δείτε το LICENSE.