Skip to content

Nameless MUCK (NMC Project)

Sections
Personal tools
You are here: Home » Documentation
« November 2008 »
Su Mo Tu We Th Fr Sa
            1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30            
 

Documentation

Project Documentation

This section leads to our main documentation.

Please post all your comments to our Feedback Page.

General Overview Document

Read the document overview for an idea of the planned sequence of documents. This is a living list and will change over time!

Requirements

These are the formal statements that determine whether the project is on target or not. These are maintained by the management team and the basis for all testing.

The first of these is the Concept of Operations (net only) which is formal indeed but should be understandable to read (just hard to write).

The Core Concepts (net only) describes the terms used in detail...and will become even more detailed.

We've included an example (from the prototype 1 sub-project) from Enterprise Architect showing UML from a case tool is included. Do NOT link to sub-parts of this, as each time a new version is generated to the web-site, it changes the sub-part ID numbers (this will be worked around in the future). Go here to see the example.

User Documentation

These documents are meant for use by those who install and use the NMC2 system. These describe everything necessary for a user to take full advantage of NMC2.

More importantly, this is the basis for the requirements and coding. Yes, we take seriously that documents come first!

As a side effect, no new features will be allowed to be added into the project without including documentation here first.

Developer Documentation

Click here to see our Javadoc tree.

This documentation is only useful if you are going to be accessing and changing the source code of the system itself. This is primarily a JavaDoc tree. All entries in this must be included either in source-code files directly or in doc-files directories in the Java source tree per the JavaDoc tool standards.

The JavaDoc does allow external documentation links and overview.html and package.html files as well, so there are no practical limits to how much information we can add to this tree.

Old Site

We have many documents from NMC 1.x in the old site, which is still around. Go here to reach the old site.

Created by Otter
Last modified 2004-06-24 02:55 PM
 
 

Powered by Plone

This site conforms to the following standards: