Server Design Documentation

SWG:ANH Server Documentation Discussion Board

Server Design Documentation

Postby rcythr » November 7th, 2010, 2:11 am

For some time now, people have attributed the bugs in the current source code as a result of coding before thinking. i.e. lack of proper documentation. It is of my opinion that this is most definately the case; however, until now, no one has put forth the prospect of doing this documentation ex post facto. For this reason, I will put forth a proposal and hope that others are ready and willing to help.

The Unified Modeling Language (UML) is an industry standard in software engineering circles. It is for this reason that I wil suggest we use it when developing this documentation. The first step is Use Cases:

Use Cases
According to Wikipedia, use cases are: " "who" can do "what" with the system in question". This means that a use case describes all of the people (known as actors) involved in a system, and all of the things that they can do. I am currently in the process of creating such a diagram; however, it is difficult doing this before knowing what the entire list of use cases is. Therefore, I have begun such a list and hope for help. (See Below)

Administrator
    Manage Server
      Start
      Shutdown
      Restart
      Update
    Manage World
      Manage Weather
      Manage NPC
      Manage Structure
      Manage Player
      Manage Chat
    Manage Accounts
      Toggle Ban
      Toggle Activation Status
      Set Account Jedi Status
      Change Account Name
      Change Account Password
      Change Account Email
    Manage Characters
      Undelete Character
      Rename Character
      Transfer Character

User
    Login to Account
    Logout of Account
    Manage Characters
      Create Character
      Delete Character
      Login to Character
      Logout of Character
    Artisan
      Manage Access Fee
      Sample Resource
      Survey Resource
    Smuggler
      Slicing
    Entertainer
      Play Music
      Dance
      Use Effects
      Use Flourish
      Image Design
    Bounty Hunter
      Droid Find
      Droid Track
    Squad Leader
      Send Message
    Scout
      Harvest Corpse
      Forage
      Mask Scent
    Bio-Engineer
      Sample DNA
    Medic
      Medical Forage
    Converse NPC
    Ranger
      Tracking
      Conceal
    Creature Handler
      Train Pet Commands
      Tame Creature
    Politician
      Create City
      Join City
      Set City Specialization
      Upgrade City
      Grant Zoning Rights
      Manage Taxation
        Manage Property Tax
        Manage Citizen Tax
        Manage Sales Tax
        Manage Travel Fee
      Manage Militia
        City Ban
        City Pardon
        City Warn
      Place Civic Structure
      Place Commercial Structures
      Place Trainers
      Register City
    Character Creation
      Specify Species
      Specify Gender
      Customize Character Appearance
      Choose Starting Professions
    Movement
      Walking
      Burst Run
      Follow
    HUD
      View HAM
      View Wounds
      View Posture
      View States
    Chat
      View Chat
      Speak in Chat
      Change Mood
      Create Channel
      Moderate Channel
        Invite Player
        Uninvite Player
        Kick Player
        Give Moderator
        Revoke Moderator
        Destroy Channel
      Join Channel
      Leave Channel
      Refresh Channel Listing
    Map
      View World Map
    Inventory
      Equip Item
      Dequip Item
      Examine Item
        View Condition
      Trade Item
      Transfer Item
      Loot Item
      Loot All Items
    Datapad
      Manage Waypoints
        View Details
        Activate Waypoint
        Deactivate Waypoint
        Create Waypoint
        Set Name
        Destroy Waypoint
      Manage Missions
        Abort Mission
        Activate Waypoint
        Deactivate Waypoint
      View Schematics
        View Details
    Character Sheet
      View Character Information
    Skills
      View Skills
      View Remaining Skill Points
      View Experience
      View Skill Modifiers
      Unlearn Skill
    Email
      View Messages
      Send Message
      Delete Message
    Community
      Modify Personal Information
        Add Trait
        Remove Trait
        Reset Traits
        Make Profile Search able
        Change Sensitivity
        Change Search Interval
      Modify Character Information
        View Previous Matches
        Change Current Title
        View Badges
        Change LFG Status
        Change Newbie Helper Status
        Change Role-Player Status
        View/Modify Biography
      Search for Players
      Modify Friends
        Add Friend
        Remove Friend
      Modify Ignore
        Add Ignore
        Remove Ignore
    Abilities
      View Abilities
    Holocron
      Submit Bug
      View Help Files
    Game Menu
      Logout
      Exit Game
    Radar
      View Nearby Objects
    Converse with NPC
    Skill Trainers
      Learn Skill
    Combat
      Target
        View Target Information
      Enqueue Command
      Dequeue Command
      Peace
      Clear Queue
    Modify Posture
      Stand
      Kneel
      Prone
    Throw Item
    Fire Item
    Consent
      Grant Consent
      Revoke Consent
    Entertainer
      Start Dancing
      Stop Dancing
      Start Music
      Stop Music
      Listen to Player
      Watch Player
    Missions
      View Missions
      View Mission Details
      Refresh Missions
      Accept Mission
    Groups
      Invite Player
      Join Group
      Group Chat
      Kick Player
      Disband Group
      Transfer Leadership
      Show Group Options
      Toggle Autosplit
      Toggle Autoloot
        Autoloot Items
        Autoloo Credits
      Toggle Notifications
        Notify Credits
        Notify Items
        Notify Harvest
        Notify Incapacitation
        Notify Death
      Show Group Leader
    Travel
      View Destinations
      Purchase Ticket
      Use Ticket
    Structure
      Place Structure
      Name Structure
      Manage Input Hopper
      Manage Output Hopper
      Manage Target Resource
      Manage Power
      View Progress (current amount harvested)
      View Efficiency (units per second)
      View Status (health)
      Dump Hopper
      Manage Maintenance
      Destroy Structure
      Manage Structure Permissions
      Manage Privacy
      Declare Residence
      Vendor List
    Guilds
      Show Guild Information
      Enemies
        View Enemies
        Add Enemies
        Remove Enemies
      Disband Guild
      Change Guild Name
      Members
        View Members
        Set Allegiance
        Set Title
        Kick
        Change Permissions
      Sponsor for Membership
      View Sponsored for Membership
      Guild Chat
    Crafting
      Select Schematic
      Select Resources
      Experiment
      Create Prototype
      Create Manufacturing Schematic
    Bazaar
      Browse Galactic Bazaar
      Buy
      Place Bid
      Sell Item
      Start Auction
    Factions
      Join Faction
      Spend Faction Points
      Change PvP status
      Quit Faction
      Place Faction Perk Structures
      Destroy Faction Perk HQ
        Jam Uplink Terminal (Bounty Hunter: Investigation II)
        Slice Security Terminal (Smuggler: Slicing I: Terminals)
        DNA Sequence Override (Novice Bio-Engineer)
        Switch Alignment of the Power Regulator (Commando, Heavy Support Weapons I)
        Activate Overload at Primary Terminal (Novice Squad Leader)
      Prevent HQ Destruction
      Donate Perk to Base
    Duel

As you can see, the list is quite long. If you notice anything missing, please post it. You don't need to say exactly where it needs to go unless you wish to. I can sort the list out.
Image
rcythr
Retired SWG:ANH Staff
 
Posts: 52
Joined: January 28th, 2009, 7:55 pm
SWG Official Server: Naritus

Re: Server Design Documentation

Postby rcythr » November 7th, 2010, 10:48 pm

Activity Diagrams

Login to Account -
Main
Logout Account -
Main
Create Character -
Main
Validate
Random Name Gen
Delete Character -
Main
Work in Progress...
Image
rcythr
Retired SWG:ANH Staff
 
Posts: 52
Joined: January 28th, 2009, 7:55 pm
SWG Official Server: Naritus

Re: Server Design Documentation

Postby rcythr » November 7th, 2010, 11:33 pm

Reserved...
Image
rcythr
Retired SWG:ANH Staff
 
Posts: 52
Joined: January 28th, 2009, 7:55 pm
SWG Official Server: Naritus

Re: Server Design Documentation

Postby rcythr » November 7th, 2010, 11:34 pm

Reserved...
Image
rcythr
Retired SWG:ANH Staff
 
Posts: 52
Joined: January 28th, 2009, 7:55 pm
SWG Official Server: Naritus


Return to Documentation

Who is online

Users browsing this forum: No registered users and 1 guest

cron