Design Document

From Species File Help
(Difference between revisions)
Jump to: navigation, search
m (added link to editing)
(Added paragraph on revised use of design document as part of software development process)
Line 1: Line 1:
 
+
A design document is a tool used within the context of SFS development. It is largely used as an internal tool for communicating detailed ideas about the formal structure and function of potential changes to the SFS software and website. It is used at various stages in the development process. Initially it can be used to set out proposed ideas and later as a guide of work yet to be done.
Id propose outlining the basic hierarchy like so:
+
 
+
The bold words will be the page name.
+
 
+
The bit in [] just a note as to what it represents (not shown else).
+
{} is a suggestion/something waiting to be filled out.
+
 
+
''just a demo here, not meant to be actual organization:''
+
 
+
* '''Manual''' [We anticipate multiple different types of manuals]
+
** '''SpeciesFile''' [We can anticipate multiple "products" from SF]
+
*** '''Web''' [Particular to the web front end]
+
***** {Some category}
+
** '''Developer'''
+
 
+
Some bold words possibly represent 'portals'? Notice some terms now link to pages. --[[User:Maehr|MikeMaehr]] 14:25, 6 April 2012 (CDT)
+
 
+
== Higher Level Categories ==
+
 
+
*'''Programming''' [Background on the data architecture and underlying development environment, data tables and more]
+
**Table relationships
+
**Table structure
+
**Access levels
+
*'''Administration'''
+
**Edit log
+
**Object id's
+
**Secure functions
+
**[[Restricted taxon changes]]
+
**Managing users
+
*'''Lists'''
+
**List of Species Files
+
**[[List of Test Programs]]
+
**List of video tutorials
+
**[[List of acronyms]] [GBIF, TDWG, LSIDs]
+
*'''Public'''
+
**(see manual)
+
*Biodiversity informatics community resources
+
**Biodiversity Heritage Library
+
**Biodiversity Collections Index
+
**GBIF
+
*[[Editing]] [The primary means of working with data - kind of a wastebasket category]
+
**Taxon pages
+
***nomenclator
+
***external links
+
***Scrutiny
+
***ecology
+
***LSID's
+
**Specimens
+
***primary types
+
***repositories
+
**Media types
+
***Images
+
***Sounds
+
***Videos
+
***PDFs
+
**Distributions and Maps
+
***TDWG area maps
+
***Google maps
+
***Faunal lists
+
**[[Reference]]
+
***[[Citation]]
+
***[[Publication]]
+
***[[Author]]
+
**[[People]]
+
**[[Test Programs]]
+
**[[Data source]]
+
**Keys
+
**Import and export
+
**Fossils and extinct taxa
+
**Search functions
+

Revision as of 10:21, 18 July 2012

A design document is a tool used within the context of SFS development. It is largely used as an internal tool for communicating detailed ideas about the formal structure and function of potential changes to the SFS software and website. It is used at various stages in the development process. Initially it can be used to set out proposed ideas and later as a guide of work yet to be done.

Personal tools
Namespaces

Variants
Actions
Navigation
Species Files
Wiki
Toolbox