Survey documentation structure of other projects The NetBSD Project
Status: Closed Time to complete: 72 hrs Mentors: Radoslaw Kujawa, Aleksej Saushev, Julian Coleman, Julian Fagir Tags: research, comparison, overview

There are many open source projects which exist not only for years, but also for decades (which e.g. NetBSD also nearly does with 19 years). For all of them, documentation is an important issue, and most, if not all projects have not mastered writing documentation.
In this task, you have to choose on of the projects listed below. If you want to research another project not listed, please ask a judge about it.
Then, you have to research the documentation of these projects (what sources are there, how are they used, which software do they use, which formatting language, etc. (what sources are there, how are they used, which software do they use, which formatting language, etc.), plus finding a way of determining the project's opinion of their documentation (a docs@ mailinglist might be a good start, like e.g. NetBSD-docs@NetBSD.org is). All in all, you should do nearly the same as the task "Create an overview of NetBSD documentation", except that you don't have to be that much in depth, but you should also research the technical and administrational background.
In the end, you should write a paper with the results of the survey and a small text, at least one page at all.


This task can be fulfilled multiple times, once for each project. It will be recreated once it's claimed.

Possible projects: Debian, FreeBSD, OpenBSD, DragonFly, Gentoo, Arch Linux, Slackware, PostgreSQL 

Uploaded Work
File name/URL File size Date submitted
Documentation Structure.txt 2.6 KB January 04 2013 22:08 UTC
Documentation Structure.txt 3.7 KB January 05 2013 07:40 UTC
Comments
Shayantan on November 30 2012 10:56 UTC Claim

Hey julian , I Would Like To Claim This Task

Shayantan on November 30 2012 10:57 UTC Task Claimed

I would like to work on this task.

Radoslaw Kujawa on November 30 2012 17:24 UTC Task Assigned

This task has been assigned to Shayantan. You have 72 hours to complete this task, good luck!

Shayantan on November 30 2012 19:01 UTC hello

Hey . I Need Help On The Task . Should I Download One Of The Operating Systems given below ?

Shayantan on November 30 2012 19:03 UTC Claim Removed

The claim on this task has been removed, someone else can claim it now.

Vijay Nandwani on January 4 2013 21:32 UTC Task Claimed

I would like to work on this task.

Vijay Nandwani on January 4 2013 21:32 UTC FreeBSD

I am interested in researching the documentation structure of FreeBSD

Julian Fagir on January 4 2013 21:37 UTC FreeBSD is good

FreeBSD is a good project for this.


But you have to be careful, as FreeBSD has many places for its documentation, partially in two places.


 


 

Julian Fagir on January 4 2013 21:37 UTC Task Assigned

This task has been assigned to Vijay Nandwani. You have 72 hours to complete this task, good luck!

Vijay Nandwani on January 4 2013 21:51 UTC Thank you

Thank you for assigning me the task.


 


I have one question. What does the following line in the description means?

plus finding a way of determining the project's opinion of their documentation (a docs@ mailinglist might be a good start, like e.g. NetBSD-docs@NetBSD.org is)

Does the project here refer to the project which we are researching for or something else. 

Vijay Nandwani on January 4 2013 22:10 UTC File submitted

I have submitted a file with all the information. If the file requires some more information or needs some editing, please inform me. 

Thank you :) 

Vijay Nandwani on January 4 2013 22:10 UTC Ready for review

The work on this task is ready to be reviewed.

Julian Fagir on January 4 2013 22:26 UTC Good start

This is already a good start, but please provide more information about what the single documentation platforms really document.


Please say more for what kind of information the wiki is used, and when the SGML documentation, and when the manpages.


 


 

Julian Fagir on January 4 2013 22:26 UTC Task Needs More Work

One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.

Vijay Nandwani on January 5 2013 07:41 UTC Ready for review

The work on this task is ready to be reviewed.

Julian Fagir on January 5 2013 15:49 UTC Thank you!

Thank you for your submission, this is exactly the kind of work we expected.


As you did this task in very a good manner, maybe you want to do this with further projects (esp. Arch Linux would be interesting imho)? I recreated this task if you want to do it a second time: http://www.google-melange.com/gci/task/view/google/gci2012/8202203

Julian Fagir on January 5 2013 15:49 UTC Task Closed

Congratulations, this task has been completed successfully.

Vijay Nandwani on January 5 2013 16:32 UTC Thanks a lot!

Thanks a lot Julian Fagir! My current task is ready, I just need to submit that. After that I'll definately try to do another task of this kind. 

Thank you :)