Poll : what documentation is missing in JNode ?

I'm taking a Software Engineering class this semester. As part of the course, I need to find an open source project and create/modify lots of high-level documentation, including Concept of Operations, Requirements, and the like. I selected JNode as I'm most experienced with Java and this project interested me. Here's the full breakdown of what I need to create in some form:

# Concept of Operations Document (first up, I'm working on it today)
# Software Requirements Document (I was planning on restricting it to Draft 0.3 additions and core functionality, unless people have more they can help steer me toward)
# Software Architecture Document (The overall structure of the system, I believe this can be compiled from clever re-usage of the Teams aspect of the project)
# Design Document (Full modeling of it all, though I'll likely simplify good bits as modeling an operating system is no small task)
# Test Plan (Not that far yet)
# Test Report (Not that far yet)

Since I'm required to create all of the stuff above, I hope that'd help with some of the higher-level documentation that right now is missing.

TaCktiX
David Bunn

JavaDoc documentation is missing. As a system architect, I want to look at an operating system at a very high level, the package level and higher. When completed, JavaDoc documentation increases the comprehension of the APIs.

It answers questions about feature such as:

Does it exist?

Has someone thought of it already, possibly under a different name and terminology?

How much effort is required to write a plug-in? a command?

Thanks,

Hi,

I'm new here.

I discovered the the 'printer friendly page' link in the documentation section of the site provides a single page with all the documentation.

At least give this link more visibility, and add it to the main download page.

Brett

Just to throw my two unasked-for U.S. cents into the mix, I have seen very good results with integrating DokuWiki[1] into Drupal, allowing for
shared logins and CMS + Wiki capabilities.

One plugin for DokuWiki, called Discussion, seems to be a good fit for this site as well. The Discussion wiki allows people to saved threaded comments on a wiki page as meta-data, rather than modifying the page content itself. This allows the articles to stay relatively on-topic, yet still have threaded discussions related to the page linked right to the page, like those on the Drupal nodes now. The discussion piece can also be linked to a separate page like MediaWiki's talk tabs if you like.

There are a ton of other DokuWiki plugins I could see as well, such as the Blog plugin with links to the Drupal user pages, or a user:username wiki page, and more. If someone does install Doku, and you have questions about it, feel free to e-mail me or IM me about them.

[1] DokuWiki http://wiki.splitbrain.org/
--
Robert "Exile In Paradise" Murphey

I think you're right Fabien, we need a better documentation. At this moment we have a lot of it, only thing is, that beside our documentation section, it's spread out all over our forums and one have to do a lot of searching and have read the threads as they was written. It would be a help if we could collect whats allready pressent into a common document.

Martin

I want to express my opinion about documentation too, so I'll do that now:

I personally would prefer if we switch to mediawiki for our documentation but also keep drupal for normal forum discussions and user questions. The reason I like mediawiki is, that anyone may help to enhance the documentation. There are for sure many people (also noobs) that could help make JNode docs better, write new docs or only correct the language (native speakers). Even if someone writes a documentation page that has many errors, I belive that it will get corrected very soon because of the nice way to track changes and see diffs.

I don't like track that much because it would fully replace drupal and would have the same downsides for documentation.

And I don't like openoffice or something like that because it makes it very hard to track changes (binary diffs *shrug*). It will be usefull for a complete user-documentation perhaps, but I don't think we're at a point to need that yet. Imho we need a simple and easy doc-system to track stuff that is needful for other developers and "users".

About spam: At the moment we have a high amount of those §"%*$&, but we manage to delete it very quickly imho. And afaik we're only 3 guys that have permission to delete spam at all. With mediawiki I'm sure there would be many more that would (and could) delete spam. Imho spam wouldn't be a real problem with mediawiki. (And Fabien just noted that there are even patches to mediawiki to include spam filter for submissions)

To note that again, that's my opinion and probably not shared by all other developers

The task of writing documentation needs to be opened up and made easier.

Currently, the only way I can write documentation is to write it offline and submit it as patches. AFAIK, there are currently only 2 people who are able to / have time to make changes to the online documentation pages. The project should be set up to allow JNode users (especially native English speakers!!) to contribute and update documentation rather than making it hard for them to do this.

The second problem is that the platform we are using for creating / presenting documentation is too primitive. For example, since articles can't use <pre> or <verbatim> tags, it is next to impossible to put properly formatted Java code into an article. Perhaps the this can be addressed by alter configuration parameters, updating to a newer version, etc. If not, we need to move to a better platform.

Finally, I'm not convinced that raw HTML (or some Wiki markup) is the right medium for writing documentation. IMO, it would be better to use a fully fledged document format / editor (e.g. ODF / OpenOffice) with appropriate document styles and conventions.

hai,
all
It is true that we need more enhancement in the JNode's Documentations.That will help all.

My proposal(i told to FabienD already about it) is to use TRACK for seeing a WIKI like Web Content Site for JNodeDOCs.There we can create our JNode Wiki as a Wikipedia site.As the current Documentation portion will need major changes.So, Using Track we can get it easily.
An example site who are using the Track for their Doc's page is YASM.

IS it not better?what is your opinions? Reply frankly
Thanks
tanmoy