Survey documentation structure of other projects The NetBSD Project
Status: Closed Time to complete: 96 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: OpenBSD, DragonFly, Gentoo, Arch Linux, Slackware, PostgreSQL 

Uploaded Work
File name/URL File size Date submitted
Arch_Linux.txt 2.8 KB January 07 2013 13:37 UTC
Arch_Linux.txt 6.6 KB January 07 2013 16:20 UTC
Comments
Vijay Nandwani on January 7 2013 12:33 UTC Task Claimed

I would like to work on this task.

Vijay Nandwani on January 7 2013 12:34 UTC Project Name

I am interested in researching the documentation structure of Arch linux.

Thank you :) 

Julian Fagir on January 7 2013 12:55 UTC Task Assigned

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

Vijay Nandwani on January 7 2013 13:38 UTC Ready for review

The work on this task is ready to be reviewed.

Julian Fagir on January 7 2013 14:21 UTC Please be a bit more specific about the categories

The text is fine, but please be a bit more specific about the avtual contents of the wiki.


Is there a special documentation team writing documentation, and if so, how do they organize?


And what about the categoriea, how are they organized? Also, when I go to the fontpage, there are special articles in the wiki linked (intsallation guide, beginners guide).

Julian Fagir on January 7 2013 14:21 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 7 2013 16:20 UTC Ready for review

The work on this task is ready to be reviewed.

Vijay Nandwani on January 7 2013 16:22 UTC Added a lot more info

I have added a lot more information to the file. Information about all the categories, navigation, important pages, special teams, the way they work..etc. are all now present in the file. If you want anything more to be added, please inform me.

Thank you :) 

Julian Coleman on January 7 2013 18:33 UTC Task Closed

Congratulations, this task has been completed successfully.