Thread 'Documentation'

Message boards : The Lounge : Documentation
Message board moderation

To post messages, you must log in.

AuthorMessage
Eric Myers
Avatar

Send message
Joined: 12 Feb 06
Posts: 232
United States
Message 10657 - Posted: 4 Jun 2007, 16:08:23 UTC

I think I see something that is not there.

Or rather I see something we need which is not there.

How about a separate forum for Documentation? It's an important part of the project, but there's no separate area for discussing it.


-- Eric Myers

"Education is not the filling of a pail, but the lighting of a fire." -- William Butler Yeats
ID: 10657 · Report as offensive
mo.v
Avatar

Send message
Joined: 13 Aug 06
Posts: 778
United Kingdom
Message 10673 - Posted: 5 Jun 2007, 2:15:15 UTC

I would very much welcome that. Are you suggesting a section purely about documentation relating to boinc itself, or might there also be threads about the documentation provided by projects? At the moment there's no central venue for comparison/improvement/possible sharing of the large amount of documentation produced by the projects.
ID: 10673 · Report as offensive
ProfileKSMarksPsych
Avatar

Send message
Joined: 30 Oct 05
Posts: 1239
United States
Message 10675 - Posted: 5 Jun 2007, 3:03:16 UTC

It's an interesting idea.

We do have better central documentation now with the Wiki integrated into Trac. But it would be nice to see it here as well.

I can't remember if David opened page creation on the wiki to everyone, but I do believe that editing is open with an account.

A documentation forum here would allow discussion before things are inserted into the Wiki.

And as Mo pointed out, there really is no central repository for project information. If you're trying to decide between Rosetta, Predictor, Tampaku, Proteins and Docking, you have to dig through each separate message board and then try to compare. A central place for documentation may make that process easier.
Kathryn :o)
ID: 10675 · Report as offensive
Eric Myers
Avatar

Send message
Joined: 12 Feb 06
Posts: 232
United States
Message 10685 - Posted: 5 Jun 2007, 12:26:11 UTC - in response to Message 10673.  

mo.v wrote:
I would very much welcome that. Are you suggesting a section purely about documentation relating to boinc itself, or might there also be threads about the documentation provided by projects? At the moment there's no central venue for comparison/improvement/possible sharing of the large amount of documentation produced by the projects.


I noticed that there are sections for all major components of the system (along with a lounge, of course :-) but no place to *discuss* and plan documentation. If we treated documentation as another major component and could discuss options and ideas I would expect it would improve in many ways.

I've been working on a new front page for the unofficial wiki, though the design could transfer over to Trac as well, if people like it. There's been long discussion on the talk page of the main page of that wiki, but it's an awkward way to have a continuous dialogue about ideas and to cover many topics.

I considered inviting folks to discuss new ideas on Pirates, and we can still do that too, but it seems this forum might be the best place for everybody to get together and discuss documentation.

And I would encourage discussion of both the official Berkeley documentation and other sources, like the unofficial wiki, the various projects, etc. This would not be the documentation itself, it would be meta-documentation, a discussion about the documentation.


-- Eric Myers

"Education is not the filling of a pail, but the lighting of a fire." -- William Butler Yeats
ID: 10685 · Report as offensive
ProfileJord
Volunteer tester
Help desk expert
Avatar

Send message
Joined: 29 Aug 05
Posts: 15566
Netherlands
Message 10688 - Posted: 5 Jun 2007, 15:22:13 UTC

Someone here reads requests. ;-)

A whole new forum.
ID: 10688 · Report as offensive
ProfileKSMarksPsych
Avatar

Send message
Joined: 30 Oct 05
Posts: 1239
United States
Message 10692 - Posted: 5 Jun 2007, 17:15:47 UTC - in response to Message 10688.  

Someone here reads requests. ;-)

A whole new forum.



Now that's what I call fast service :-)
Kathryn :o)
ID: 10692 · Report as offensive

Message boards : The Lounge : Documentation

Copyright © 2024 University of California.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation.