Forum .LRN Q&A: dotLRN documentation - what we have and what we need?

1: dotLRN documentation - what we have and what we need?

Posted by Mohan Pakkurti on 12/18/02 11:39 AM

Here is the current list of all the documentation that we have for dotLRN.

General/User docs The user docs are very useful and upto date thanks to the work done by Deirdre Kane from Sloan. Some of the docs need to be generalised to be dotLRN docs from the Sloan Manuals.

Short feature overview
Tour for professors (powerpoint)
Tour for students (powerpoint)
Sloan User FAQs
Sloan Admin FAQs
Sloan User guides
dotLRN 1.0 User and Administrator Handbook LRN

Developers docs

Currently exist in the dotlrndoc package and they should be moved to the standard OpenACS docs location dotlrn/www/doc

Writing a dotLRN Package
dotLRN Architecture
dotLRN Nomenclature: a dotLRN Primer
dotLRN Roles, Sections, and Permissions
dotLRN Portal Permissions

I have reviewed the developer docs. The docs are not complete and are inadequate to really help a new developer, and for the experienced dotLRN developer they are not complete enough to be useful. We should discuss the usefulness of including then in the dotLRN 1.0 release.

So, does any one have opinions on what other docs we need for dotLRN?

Cheers

2: Re: dotLRN documentation - what we have and what we need? (response to 1)

Posted by Malte Sussdorff on 12/18/02 12:16 PM

I might be a little bit dump, but is there a link to all the documentation that you describe (aka, is it on a single site?).

Furthermore, where should we send additional material to (as I think we will be writing up some marketing materials).

3: Re: dotLRN documentation - what we have and what we need? (response to 1)

Posted by Nick Carroll on 01/07/03 04:42 AM

I would like to see some documentation on the new-portal package. Such as a HOWTO guide to create your own portlets, and to display them on a particular page.

4: Re: dotLRN documentation - what we have and what we need? (response to 1)

Posted by sonali bhirud on 05/24/04 01:36 PM

Plese inform me the address/location of "Tour for Proffesors" & "Tour for students" Or

where "Tour for Proffesors" & "Tour for students"is available on site?

5: Re: dotLRN documentation - what we have and what we need? (response to 1)

Posted by Don Baccus on 05/24/04 04:48 PM

I'll document the portals package when the rewrite is included in .LRN (tentatively planned for .LRN 2.1). The process of creating a portal has changed drastically (it is much simpler) so any documentation written for the .LRN 2.0 version would have to be rewritten, and I don't really have time to do it twice.

.LRN 2.1 is scheduled to be released mid-summer ...

6: Re: dotLRN documentation - what we have and what we need? (response to 1)

Posted by Bruce Spear on 05/28/04 08:19 AM

Thanks for raising this question, Mohan!
How about integrating your list with the wonderful collection of openacs documentation Jade has compiled over on the openacs site?
For user docs, I would also suggest that we integrate these sites to reflect whatever structure Malte might set up with his proposed context-dependent help system, and also, that we make this interactive, maybe including a forum format, so we could more freely share quick "how-to's" rather than always face editing burdens?

7: Re: dotLRN documentation - what we have and what we need? (response to 6)

Posted by Jade Rubick on 05/28/04 06:24 PM

I'd like to move a lot of my documentation into the acs-core-docs, so that I can give up ownership of it and others can improve it. If anyone has any pages they're interested in moving into XML, it's pretty easy to do, and I'll be happy to see it moved over.