Solving the documentation problem. Capturing tacit knowledge. Knowledge reuse.

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
23 messages Options
12
Reply | Threaded
Open this post in threaded view
|

Re: Solving the documentation problem. Capturing tacit knowledge. Knowledge reuse.

Stéphane Ducasse
what would be better is to use an infrastructure similar to the one
of http://book.seaside.st (port pdf or latex into pier syntax - lukas has a bunch of scripts)
since we can generate pdf from it.
But this is not me that will do it (but I would support and encourage people to do it).

Stef


On Jan 1, 2010, at 9:16 PM, [hidden email] wrote:

> Adrian,
>
> This is a problem of simple solution: volunteer to convert the LaTeX PBE book to HTML and find a place to host it!
>
> my 0.019999...
>
> --
> Cesar Rabak
>
>
>
> Em 01/01/2010 03:47, Adrian Kuhn < [hidden email] > escreveu:
>
>
> Schwab,Wilhelm K  writes:
>
>> This sounds like a great way to augment documentation, but I still like class
>> and method comments - Stef might want to work on the train :)  Various things
>> mentioned here recently (such as threading) will hopefully get chapters in
>> PBE.
>
> My (general) problem with book chapters is that they are not googlable.
>
> For example the awesome chapter on how exceptions work that was sent around on
> this list some time ago. Nobody will *ever* gonna stumble upon that chapter
> when googling (or binging, et cetera) for "exceptions smalltalk". OTOH, when I
> write a blog post it is indexed within 2 minutes!
>
> --AA
>
>
> _______________________________________________
> Pharo-project mailing list
> [hidden email]
> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
>
>
> _______________________________________________
> Pharo-project mailing list
> [hidden email]
> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project


_______________________________________________
Pharo-project mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
Reply | Threaded
Open this post in threaded view
|

Re: Solving the documentation problem. Capturing tacit knowledge. Knowledge reuse.

laurent laffont
In reply to this post by Stéphane Ducasse


The way to go is
       - having browsers showing doc all the times
       (like the old browser was showing the class def and the class comment)
       - defining better tools to browse documentation.
       I started (but did not finish) to use the new tree developed by alain to
       provide a package
                       |> class
                               class comment
                               V method
                                       methodcomment
                                    method
                                       methodcomment
                       |> class
                               class comment
                               |> methods
                       |> class
                               class comment
                               |> methods

       We need a better version of
                       ClassTree new openOn: Collection


Stef
 
I have written a web based documentation browser  for me here: http://www.squeaksource.com/SimpleWebDoc.html  (screenshots: http://picasaweb.google.com/laurent.laffont/Simplewebdoc ) and I'm currently learning morphic to do something similar in a browser. Is your code on squeaksource ?

Happy new year !

Laurent Laffont

_______________________________________________
Pharo-project mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
Reply | Threaded
Open this post in threaded view
|

Re: Solving the documentation problem. Capturing tacit knowledge. Knowledge reuse.

Stéphane Ducasse
laurent

my code was too little to be of any interest.
Now the examples illustrating the TreeMorphTreeMorph class show
one possible direction

On Jan 2, 2010, at 9:55 AM, laurent laffont wrote:

>
>
> The way to go is
>        - having browsers showing doc all the times
>        (like the old browser was showing the class def and the class comment)
>        - defining better tools to browse documentation.
>        I started (but did not finish) to use the new tree developed by alain to
>        provide a package
>                        |> class
>                                class comment
>                                V method
>                                        methodcomment
>                                     method
>                                        methodcomment
>                        |> class
>                                class comment
>                                |> methods
>                        |> class
>                                class comment
>                                |> methods
>
>        We need a better version of
>                        ClassTree new openOn: Collection
>
>
> Stef
>  
> I have written a web based documentation browser  for me here: http://www.squeaksource.com/SimpleWebDoc.html  (screenshots: http://picasaweb.google.com/laurent.laffont/Simplewebdoc ) and I'm currently learning morphic to do something similar in a browser. Is your code on squeaksource ?
>
> Happy new year !
>
> Laurent Laffont
> _______________________________________________
> Pharo-project mailing list
> [hidden email]
> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project


_______________________________________________
Pharo-project mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
12