Editing GS Developers Guidelines

From BRL-CAD

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
{{DesignDocument}}
 
 
 
----
 
----
 
==Development Procedure==
 
==Development Procedure==
Line 14: Line 12:
 
# Build [[GS Sequence Diagram Standard|Sequence Diagrams]].
 
# Build [[GS Sequence Diagram Standard|Sequence Diagrams]].
 
# Refine [[GS Class Diagram Standard|Class Diagrams]] by adding methods.
 
# Refine [[GS Class Diagram Standard|Class Diagrams]] by adding methods.
# [https://brlcad.svn.sourceforge.net/viewvc/*checkout*/brlcad/brlcad/trunk/HACKING Implement code].
+
# [[GS Code Implementation Standard|Implement code]].
  
 
*At any given step, if a change needs to be made to a previous step, then step down the process flow from the change back to where you were working.  This will ensure that a change made in step 3 will be accurately reflected in all subsequent steps.
 
*At any given step, if a change needs to be made to a previous step, then step down the process flow from the change back to where you were working.  This will ensure that a change made in step 3 will be accurately reflected in all subsequent steps.
*Communication is KEY.  If anyone makes a change anywhere in the documentation, a simple email to the dev team or log entry will suffice.
 
*Requirements, Actor Definitions, Use Case Text Descriptions, and Package Lists will be maintained here on the wiki.
 
*Use Case Diagrams, Graphical Package Lists, Class Diagrams, and Sequence Diagrams will be based on our UML editing application files and therefore maintain them would be difficult via a wiki.  These will be maintained in the BRL-CAD SVN store: /brlcad/src/geoservice/devdocs/
 
 
  
 
Note: The best '''''freeware''''' version of a UML documentation application (for Win32) that I have found thus far is [http://www.staruml.com/ StarUML ].  [http://uml.sourceforge.net/index.php Umbrello] is a good one for Linux/GNOME.  If you know of one better, PLEASE mention it.  The sooner we settle on the applications we use for development, the less re-work we will have to do.  (I prefer ZERO rework, but that's a bit unreasonable.)
 
Note: The best '''''freeware''''' version of a UML documentation application (for Win32) that I have found thus far is [http://www.staruml.com/ StarUML ].  [http://uml.sourceforge.net/index.php Umbrello] is a good one for Linux/GNOME.  If you know of one better, PLEASE mention it.  The sooner we settle on the applications we use for development, the less re-work we will have to do.  (I prefer ZERO rework, but that's a bit unreasonable.)

Please note that all contributions to BRL-CAD may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BRL-CAD:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Template used on this page: