Τεχνική συγγραφή
Εγχειρίδια, οδηγοί και τεκμηρίωση που ο χρήστης μπορεί να ακολουθήσει χωρίς να καλέσει υποστήριξη.
Βασικά χαρακτηριστικά
- Σχέδιο τεκμηρίωσης: κοινά, τύποι περιεχομένου, δέντρο σελίδων
- Άρθρα, οδηγοί ή κεφάλαια εγχειριδίου σε Markdown, Word ή στο εργαλείο του κέντρου βοήθειάς σας
- Σχολιασμένα στιγμιότυπα οθόνης και διαγράμματα όπου ένα βήμα τα χρειάζεται
- Λίστα ορολογίας και οδηγός συγγραφής για μελλοντικούς συνεισφέροντες
- Τίποτα δεν χρεώνεται εδώΛαμβάνετε πρώτα γραπτή προσφορά. Χωρίς πληρωμή, χωρίς δέσμευση.
- Πωλείται και παρέχεται από την GRADAXΈνα συμβόλαιο και μία ομάδα, όποιος κι αν κάνει τη δουλειά.
- Τα δεδομένα σας μένουν στην ΕΕΤίποτα δεν μεταφέρεται εκτός της ένωσης για επεξεργασία.
Σχετικά με αυτή την υπηρεσία
Οδηγοί χρήσης, τεκμηρίωση API, τυποποιημένες διαδικασίες λειτουργίας και άρθρα βάσης γνώσεων, γραμμένα από κάποιον που εκτελεί κάθε βήμα στο προϊόν πριν το καταγράψει. Η τεκμηρίωση είναι δομημένη ώστε η ομάδα σας να μπορεί να τη συντηρεί μετά την παράδοση, στο εργαλείο που ήδη χρησιμοποιεί.
Τεκμηρίωση γραμμένη από το προϊόν, όχι από τις προδιαγραφές
Η περισσότερη κακή τεκμηρίωση γράφτηκε από ένα έγγραφο απαιτήσεων ή από τη μνήμη ενός προγραμματιστή. Περιγράφει πώς υποτίθεται ότι θα λειτουργούσε η λειτουργία, όχι την οθόνη που βλέπει πραγματικά ο χρήστης, με το μετονομασμένο κουμπί και το επιπλέον βήμα επιβεβαίωσης. Ο χρήστης ακολουθεί το τέταρτο βήμα, δεν βρίσκει τίποτα που να ταιριάζει και ανοίγει αίτημα υποστήριξης.
Εκτελούμε κάθε διαδικασία μέσα στο προϊόν πριν τη γράψουμε, σε δοκιμαστικό λογαριασμό, με τον ρόλο που θα έχει ο αναγνώστης. Όπου ένα βήμα συμπεριφέρεται διαφορετικά από ό,τι περιμένει η ομάδα, το καταγράφουμε, γιατί η εργασία τεκμηρίωσης φέρνει συστηματικά στην επιφάνεια σφάλματα που κανείς δεν είχε αναφέρει. Αυτή η λίστα συχνά αποδεικνύεται εξίσου πολύτιμη με την τεκμηρίωση.
Διαχωρίστε την εργασία από την εξήγηση
Ένας χρήστης που προσπαθεί να εξαγάγει ένα τιμολόγιο δεν θέλει πρώτα τρεις παραγράφους για το μοντέλο χρέωσης. Ένας χρήστης που προσπαθεί να καταλάβει το μοντέλο χρέωσης δεν θέλει μια αριθμημένη λίστα με κλικ. Η ανάμειξη των δύο σε ένα άρθρο κάνει και τα δύο πιο δύσκολα να βρεθούν και πιο αργά στην ανάγνωση.
Χωρίζουμε το περιεχόμενο σε εργασίες (πώς να κάνετε ένα πράγμα), έννοιες (πώς λειτουργεί κάτι και γιατί) και αναφορά (ρυθμίσεις, πεδία, όρια, κωδικούς σφάλματος). Κάθε τύπος έχει το δικό του πρότυπο, ώστε οι σελίδες να παραμένουν συνεπείς αφού παραδώσουμε και η ομάδα σας προσθέσει το τεσσαρακοστό άρθρο.
Η λίστα ορολογίας είναι αυτό που κρατά το σύνολο συνεκτικό στον χρόνο. Αν η διεπαφή λέει «χώρος εργασίας», η τεκμηρίωση δεν λέει ποτέ «έργο» ή «λογαριασμός» για το ίδιο πράγμα. Είναι ένα μικρό έγγραφο που αποτρέπει το μεγαλύτερο μέρος της σύγχυσης που αναφέρουν οι χρήστες.
- Άρθρα εργασιών: ένας στόχος, αριθμημένα βήματα, το αποτέλεσμα που πρέπει να δει ο χρήστης
- Άρθρα εννοιών: το μοντέλο πίσω από μια λειτουργία, με διάγραμμα όπου βοηθά
- Σελίδες αναφοράς: κάθε πεδίο, ρύθμιση και όριο, σε σαρώσιμο πίνακα
- Αντιμετώπιση προβλημάτων: το μήνυμα σφάλματος όπως γράφεται, η αιτία του και η λύση
Προδιαγραφές
- Κατηγορία
- Περιεχόμενο & Κείμενα
- Τιμή
- 420 € έως 1.520 €
- Μεγέθη
- Μικρός (Ένας οδηγός), Μεσαίος (Ενότητα κέντρου βοήθειας), Μεγάλος (Σύνολο τεκμηρίωσης)
- Χρόνος παράδοσης
- 2 έως 8 εβδομάδες
- Χρέωση
- Εφάπαξ
- Τι κερδίζετε
- 4 στοιχεία, όλα μέσα στην τιμή
- Τι χρειαζόμαστε από εσάς
- Πρόσβαση στο προϊόν ή σε περιβάλλον δοκιμών, Έναν ειδικό του θέματος για μία κλήση ελέγχου ανά ενότητα, Υπάρχουσα τεκμηρίωση, αιτήματα υποστήριξης ή αποθηκευμένες απαντήσεις, ό,τι υπάρχει
- Το αγοράζουν συνήθως
- SaaS, Μεταποίηση, Τεχνολογία υγείας, Logistics
- Πωλείται και παρέχεται από
- GRADAX, ένα συμβόλαιο και μία ομάδα
- Πού υποβάλλονται σε επεξεργασία τα δεδομένα σας
- Ευρωπαϊκή Ένωση
Τι κερδίζετε
Όλα τα παρακάτω είναι μέσα στην τιμή. Τίποτα εδώ δεν είναι αναβάθμιση.
- Σχέδιο τεκμηρίωσης: κοινά, τύποι περιεχομένου, δέντρο σελίδων
- Άρθρα, οδηγοί ή κεφάλαια εγχειριδίου σε Markdown, Word ή στο εργαλείο του κέντρου βοήθειάς σας
- Σχολιασμένα στιγμιότυπα οθόνης και διαγράμματα όπου ένα βήμα τα χρειάζεται
- Λίστα ορολογίας και οδηγός συγγραφής για μελλοντικούς συνεισφέροντες
Τι αλλάζει
- Κάθε διαδικασία δοκιμασμένη βήμα προς βήμα στο πραγματικό προϊόν
- Μία εργασία ανά άρθρο, εντοπίσιμη από την αναζήτηση του κέντρου βοήθειάς σας
- Το ίδιο πράγμα με το ίδιο όνομα σε κάθε σελίδα
- Δομή που η ομάδα σας μπορεί να επεκτείνει χωρίς να ρωτήσει εμάς
Συγκρίνετε τα μεγέθη
Η τυπική τιμή για κάθε μέγεθος. Τα επιπλέον κοστολογούνται δίπλα, όχι κρυμμένα πίσω από μια κλήση.
| Περιλαμβάνεται | Ένας οδηγός420 €2 έως 3 εβδομάδες | Ενότητα κέντρου βοήθειας720 €4 έως 5 εβδομάδες | Σύνολο τεκμηρίωσης1.520 €6 έως 8 εβδομάδες |
|---|---|---|---|
| Σχέδιο τεκμηρίωσης για έναν οδηγό | Περιλαμβάνεται | Περιλαμβάνεται | Περιλαμβάνεται |
| Έως 15 σελίδες ή άρθρα | Περιλαμβάνεται | Περιλαμβάνεται | Περιλαμβάνεται |
| Σχολιασμένα στιγμιότυπα οθόνης | Περιλαμβάνεται | Περιλαμβάνεται | Περιλαμβάνεται |
| Ένας κύκλος τεχνικού ελέγχου | Περιλαμβάνεται | Περιλαμβάνεται | Περιλαμβάνεται |
| Όλα όσα περιλαμβάνει ο Ένας οδηγός, σε έως 40 άρθρα | Δεν περιλαμβάνεται | Περιλαμβάνεται | Περιλαμβάνεται |
| Άρθρα εργασίας, εννοιών και αναφοράς χωριστά | Δεν περιλαμβάνεται | Περιλαμβάνεται | Περιλαμβάνεται |
| Λίστα ορολογίας | Δεν περιλαμβάνεται | Περιλαμβάνεται | Περιλαμβάνεται |
| Δύο γύροι αξιολόγησης | Δεν περιλαμβάνεται | Περιλαμβάνεται | Περιλαμβάνεται |
| Όλα όσα περιλαμβάνει η Ενότητα κέντρου βοήθειας | Δεν περιλαμβάνεται | Δεν περιλαμβάνεται | Περιλαμβάνεται |
| Αναφορά API με δοκιμασμένα παραδείγματα αιτημάτων | Δεν περιλαμβάνεται | Δεν περιλαμβάνεται | Περιλαμβάνεται |
| Οδηγός συγγραφής για την ομάδα σας | Δεν περιλαμβάνεται | Δεν περιλαμβάνεται | Περιλαμβάνεται |
| Υπάρχουσα τεκμηρίωση μεταφερμένη στη νέα δομή | Δεν περιλαμβάνεται | Δεν περιλαμβάνεται | Περιλαμβάνεται |
| Προσθήκη στην προσφορά |
Προσθέστε ό,τι χρειάζεστε
Choose the size
Προσθέστε ό,τι χρειάζεστε
Το σύνολό σας€720
Η τυπική τιμή, συν ό,τι προσθέσετε. Επιβεβαιώνεται γραπτώς πριν ξεκινήσει οτιδήποτε· δεν χρεώνεται τίποτα μέχρι να το αποδεχτείτε.
Πώς λειτουργεί
Χαρτογράφηση
Ποιοι διαβάζουν την τεκμηρίωση, τι προσπαθούν να κάνουν και πού κολλάνε σήμερα.
Δοκιμή
Κάθε εργασία εκτελεσμένη στο προϊόν, με κάθε κλικ και οθόνη καταγεγραμμένα.
Συγγραφή
Περιεχόμενο εργασίας, εννοιών και αναφοράς χωριστά, ώστε κάθε σελίδα να απαντά σε μία ερώτηση.
Αξιολόγηση
Ο ειδικός σας ελέγχει την ακρίβεια· εμείς ελέγχουμε ότι ένας νεοεισερχόμενος μπορεί να το ακολουθήσει.
Ερωτήσεις
Μπορείτε να γράψετε τεκμηρίωση API;
Ναι, από αρχείο OpenAPI ή από τον κώδικα μαζί με χρόνο ενός προγραμματιστή. Κάθε παράδειγμα αιτήματος εκτελείται σε περιβάλλον δοκιμών πριν δημοσιευτεί.
Σε ποια εργαλεία εργάζεστε;
Markdown σε αποθετήριο, Confluence, Notion, Zendesk Guide, Intercom ή Word όταν το αποτέλεσμα είναι έντυπο εγχειρίδιο. Χρησιμοποιούμε ό,τι θα συντηρεί η ομάδα σας.
Γράφετε τεκμηρίωση για ρυθμιζόμενους τομείς;
Γράφουμε σαφείς διαδικασίες και εγχειρίδια. Τα έγγραφα που πρέπει να πληρούν πρότυπο πιστοποίησης χρειάζονται έγκριση από τον αρμόδιο ειδικό σας και εργαζόμαστε με βάση τη λίστα ελέγχου του.
Σχετικές αναζητήσεις
Σχετική εργασία
ΕφάπαξUX writingΤα λόγια μέσα στο προϊόν σας: κουμπιά, σφάλματα, κενές οθόνες και onboarding.from 290 €
Εφάπαξανάπτυξη περιεχομένου eLearningΜαθήματα χτισμένα από τη γνώση των ειδικών σας, δομημένα για τους εκπαιδευόμενους και έτοιμα για το LMS σας.from 290 €
ΕφάπαξΠρότυπα επαγγελματικών εγγράφωνΠρότυπα προσφορών, τιμολογίων, λογαριασμών και αναφορών σε Word ή Google Docs που διατηρούν τη διάταξή τους.from 290 €
ΕφάπαξΣύνοψη ερευνώνΜεγάλες εκθέσεις και μελέτες μετατρέπονται σε ενημερώσεις που διαβάζετε σε δέκα λεπτά.from 290 €
ΕφάπαξΣενάρια βίντεο για social mediaΣενάρια για Reels, TikTok και Shorts, με το hook γραμμένο για τα πρώτα δύο δευτερόλεπτα.from 290 €
ΕφάπαξΣυγγραφή case studyΙστορίες πελατών γραμμένες από συνέντευξη με τον πελάτη, με νούμερα που εγκρίνει ο ίδιος.from 290 €
Δεν σας καλύπτει κανένα πακέτο;
Ορισμένες εργασίες έχουν δική τους μορφή. Τις εξετάζουμε πρώτα και τις προσφέρουμε γραπτώς, και η κλήση εξέτασης δεν κοστίζει τίποτα.