How to properly document a project?

Discussion about everything. New games, 3d math, development tips...
Post Reply
MasterGod
Posts: 2061
Joined: Fri May 25, 2007 8:06 pm
Location: Israel
Contact:

How to properly document a project?

Post by MasterGod »

My project is stating to gain some meat and I'm afraid I wont be able to easily maintain it as I can now because I'm not properly documenting it.
Can you suggest me of ways to properly document a (big) project?
Image
Dev State: Abandoned (For now..)
Requirements Analysis Doc: ~87%
UML: ~0.5%
rogerborg
Admin
Posts: 3590
Joined: Mon Oct 09, 2006 9:36 am
Location: Scotland - gonnae no slag aff mah Engleesh
Contact:

Post by rogerborg »

  • Concept document: if that changes by much, then you're really working on a new project.
    Architectural document: list the tools and 3rd party libraries that you rely on, including versions and where to get them. Provide an overview of the main components in your system, and how they should act. You don't need an entire work flow diagram for the whole system, just an outline of what components rely on each other, and a general idea of the states that the system can be in.
    User stories: they, in toto, describe your entire product.
    Test plan: this should flow from the user stories. If you don't have a test plan, then you won't know when you're done.
Please upload candidate patches to the tracker.
Need help now? IRC to #irrlicht on irc.freenode.net
How To Ask Questions The Smart Way
Post Reply