Λοιπά θέματα

Απ: Help authoring και tech documentation tools

rousso — Fri, 14 Oct 2005 23:40:59 GMT

axaros wrote:
Γιάννη, Σωτήρη μου φαίνεται όπως λέτε και εσείς μόνοι μας τα λέμε ... και μόνοι μας τ' ακούμε...

Αχ με πληγώνεις...

εμεις οι τρείς λίγοι είμαστέ;;;;

Απ: Help authoring και tech documentation tools

axaros — Fri, 14 Oct 2005 22:32:01 GMT

rousso wrote:

Το Document! X σήμερα το άκουσα πρώτη φορά και δεν ξέρω να σας πω τίποτα σχετικά. Αναρωτιέμαι πάντως γιατί ο axaros λέει ότι χρησιμοποιεί και το Document! X και το RobboHelp. Τι κενά έχει το ένα που καλύτει το άλλο;

Το Document! X το χρησιμοποιώ για technical documentation (σας το προτείνω ανεπιφύλακτα ... είναι χρηστικότατο και γλυτώνεις άπειρο χρόνο) και το Robohelp + Robodemo για User Help authoring +
simulations ...
Προσπαθώ να φτιάχνω όσο πιο αναλυτικό context sencitive help (είτε σε .chm ή στην πιο fancy Flash help) και όταν υπάρχει χρόνος
προσθέτω και simulations των πιο βασικών tasks ... Αν θες να το τραβήξεις μπορείς να φτιάξεις και interactive simulations για εκπαίδευση χρηστών ....

Γιάννη, Σωτήρη μου φαίνεται όπως λέτε και εσείς μόνοι μας τα λέμε ... και μόνοι μας τ' ακούμε...

Απ: Help authoring και tech documentation tools

rousso — Fri, 14 Oct 2005 22:08:47 GMT

axaros wrote:
Τώρα θα μου πεις πως θα καλύψει κανείς αυτά τα έξοδα;

Ε... όπως ξέρεις αργά η γρήγορα ανακαλύτει κανείς (καθώς κλείνει την επιχείριση ή διακόπτει την δραστηριότητά του) ότι τελικά τα έξοδα υποστήριξης συν τα διαφυγόντα έσοδα από μείωση πωλήσεων είναι σαφώς περισσότερα από τα έξοδα μιας ομάδας (έστω και μονοπρόσωπης) η οποία θα ασχοληθεί με το testing και άλλης μιας (έστω και μονοπρόσωπης επίσης) ή οποία θα ασχοληθεί με το documentation.

Αλλά τα ξέρεις αυτά οπότε τι σου τα λέω;
(Τα λέω στη νύφη για να τ' ακούει η πεθερά)...

rousso

Απ: Help authoring και tech documentation tools

rousso — Fri, 14 Oct 2005 22:00:37 GMT

Α.... ξέχασα....

Έχω χρησιμοποιήσει και Help Integration Kit της Microsoft για το VS.NET....

rousso again...

Απ: Help authoring και tech documentation tools

rousso — Fri, 14 Oct 2005 21:59:19 GMT

Έχω χρησιμοποιήσει το RobboHelp το οποίο θεωρούσα ότι μάλλον ήταν ότι καλύτερο πριν 2-3 χρόνια που το χρησιμοποίησα τελευταία φορά....
Το Document! X σήμερα το άκουσα πρώτη φορά και δεν ξέρω να σας πω τίποτα σχετικά. Αναρωτιέμαι πάντως γιατί ο axaros λέει ότι χρησιμοποιεί και το Document! X και το RobboHelp. Τι κενά έχει το ένα που καλύτει το άλλο;

Anway. Γράφω μόνο documentation για τον κώδικά μου και όχι user documentation οπότε την δουλειά μου την κάνω με nDoc μια χαρά χωρίς να χρειάζεται να αγοράσω κάποια άλλη εφαρμογή. Για το architectural documentation ή το database documentation χρησιμοποιώ το UML εργαλείο μου (Sparx Systems Enterprise Architect).

Το RobboHelp πάντως μου είχε φανεί μια χαρά για end-user documentation τότε που το είχα χρησιμοποιήσει σε σχέση με ότι άλλο είχα δοκιμάσει τότε (X3 ή X4 ήταν). Ελπίζω η τελευταία έκδοση να έχει διορθώσει κάποια bugs των παλιότερων αλλά σε γενικές γραμμές καλό ήταν. Αν υπάρχει trial μπορεί να ρίξω μια ματιά και στο Document! X... και τα λέμε....

that's it...

rousso

Απ: Help authoring και tech documentation tools

axaros — Fri, 14 Oct 2005 21:47:52 GMT

cap wrote:
Γενικά ίσως να έχεις δίκιο...ελπίζω όμως, προσωπικά, να έχεις άδικο, Πανο, για το πόσοι ασχολούνται, γιατί αλλιώς...

Να παραλλάξω λίγο το θέμα θέτοντας και ορισμένα προσωπικά σχόλια; Σχετικά με το documentation, υπάρχουν δύο μεγάλες κατηγορίες:
- Code documentation
- User documenation

(Παραλείπω επίτηδες τα ενδιάμεσα - π.χ. κάποιος θα μπορούσε να υποστηρίξει οτι ΟΚ, θα μπορούσαμε να είχαμε και database documentation ή τουλάχιστον μια μορφή class diagrams ως documentation της εκάστοτε εφαρμογής - αλλα ας δούμε τι γίνεται με αυτά τα δύο πρώτα: )

- Code documentation: Με βάση την εμπειρία μου, γίνεται συνήθως "στο πόδι". Ητοι γράφουμε λίγα πρασινάκια μέσα στον κώδικά μας και ο θεός βοηθός. Για μένα, είναι καλό τον κώδικά μας πάντα να συνοδεύει ένα html/chm αρχείο το οποίο να έχει αναλύτικά περιγραφές των interfaces, classes, κλπ που χρησιμοποιούμε. ΕΙΔΙΚΑ στην περίπτωση που δεν φτιάχνουμε εφαρμογή αλλά κάτι reusable, όπως ένα API.

-User documentation: Η μεγάλη πληγή. Αν και δεν έιναι δουλειά του προγραμματιστή πάντοτε, γενικά η συμβολή του (τουλάχιστον στο reviewing) είναι συνήθως πολύτιμη. Εκεί το πρόβλημα δεν είναι, κατά τη γνώμη μου, τα εργαλεία, αλλά ο τρόπος. Είμαι οπαδός του context-sensitive help και όχι του τυπωμένου εγχειριδίου, αλλά δυστυχώς ούτε εγώ μπόρεσα ακόμα να ενσωματώσω τέτοιο σε οτιδήποτε...

Σωτήρη συμφωνούμε απόλυτα !!!
Το κακό πιστεύω είναι ότι δεν υπάρχει παιδεία support στην χώρα μας και συνεπώς και απαιτήσεις.
Φυσικά θα ήταν ιδεατό κάθε ομάδα να έχει από πίσω και αντίστοιχη help authoring και documentation.
Αλλά εδώ σπανίζουν (αν υπάρχουν δηλαδή) και τα test teams οπότε τι συζητάμε.

Τώρα θα μου πεις πως θα καλύψει κανείς αυτά τα έξοδα;

Απ: Help authoring και tech documentation tools

cap — Fri, 14 Oct 2005 20:41:45 GMT

Γενικά ίσως να έχεις δίκιο...ελπίζω όμως, προσωπικά, να έχεις άδικο, Πανο, για το πόσοι ασχολούνται, γιατί αλλιώς...

Να παραλλάξω λίγο το θέμα θέτοντας και ορισμένα προσωπικά σχόλια; Σχετικά με το documentation, υπάρχουν δύο μεγάλες κατηγορίες:
- Code documentation
- User documenation

(Παραλείπω επίτηδες τα ενδιάμεσα - π.χ. κάποιος θα μπορούσε να υποστηρίξει οτι ΟΚ, θα μπορούσαμε να είχαμε και database documentation ή τουλάχιστον μια μορφή class diagrams ως documentation της εκάστοτε εφαρμογής - αλλα ας δούμε τι γίνεται με αυτά τα δύο πρώτα: )

- Code documentation: Με βάση την εμπειρία μου, γίνεται συνήθως "στο πόδι". Ητοι γράφουμε λίγα πρασινάκια μέσα στον κώδικά μας και ο θεός βοηθός. Για μένα, είναι καλό τον κώδικά μας πάντα να συνοδεύει ένα html/chm αρχείο το οποίο να έχει αναλύτικά περιγραφές των interfaces, classes, κλπ που χρησιμοποιούμε. ΕΙΔΙΚΑ στην περίπτωση που δεν φτιάχνουμε εφαρμογή αλλά κάτι reusable, όπως ένα API.

-User documentation: Η μεγάλη πληγή. Αν και δεν έιναι δουλειά του προγραμματιστή πάντοτε, γενικά η συμβολή του (τουλάχιστον στο reviewing) είναι συνήθως πολύτιμη. Εκεί το πρόβλημα δεν είναι, κατά τη γνώμη μου, τα εργαλεία, αλλά ο τρόπος. Είμαι οπαδός του context-sensitive help και όχι του τυπωμένου εγχειριδίου, αλλά δυστυχώς ούτε εγώ μπόρεσα ακόμα να ενσωματώσω τέτοιο σε οτιδήποτε...

Απ: Help authoring και tech documentation tools

axaros — Thu, 13 Oct 2005 18:15:31 GMT

Παιδιά να υποθέσω (από τα τρεις και ο κούκος responces βασικά μόνο η αφεντιά μου και ο Σωτήρης)
ότι με την "αγγαρεία" του τίτλου του θέματος ελάχιστοι ασχολούνται ;

Και αυτό το λέω γιατί ακούω αρκετούς στο χώρο που παραπονιούνται για τεχνοφοβικούς
χρήστες των εφαρμογών τους αλλά πάρα πολύ λίγους να ασχολούνται με help authoring
και documentation.

Απ: Help authoring και tech documentation tools

axaros — Thu, 06 Oct 2005 19:09:02 GMT

Το document X έχει ένα option για να εισάγεις τα comments στο help...
Σας επισυνάπτω ένα παράδειγμα (To factory objects test του Γιάννη) ...

Απ: Help authoring και tech documentation tools

cap — Thu, 06 Oct 2005 18:49:47 GMT

Ειχα δουλέψει παλιά το Robohelp Office X3. Τότε είχε αρκετά προβλήματα (κυρίως με import από Word) αλλά ήταν αρκετά καλό για να δημιουργήσεις documentation.

Τωρα όσον αφορά code documentation, χρησιμοποιώ πολύ το nDoc μαζί με ένα VS AddIn ονόματι VB Commenter για να παράγει xml comments στον κώδικα της VB.NET.

Help authoring και tech documentation tools

axaros — Thu, 06 Oct 2005 18:27:23 GMT

Γεια χαρά σε όλους !!
Θα ήθελα να μου πείτε τη γνώμη σας για ένα θέμα που μας πονάει
όλους : To help authoring και tech documentation οποιουδήποτε είδους εφαρμογής.

Χρησιμοποιώ για technical documentation το Document! X της Innovasys (http://www.innovasys.com/) version 4.1.1.8 και τα
Robohelp Office X5 version 5.0.2 (for .NET) και Robodemo version 5.0.0 της Macromedia.

Ποια άλλα εργαλεία χρησιμοποιήτε και γενικότερα τι κάνετε με το θέματα help authoring και documentation;