Fisheries Integrated Modeling System (FIMS) Documentation
Source:vignettes/fims-documentation.Rmd
fims-documentation.RmdThis page provides information related to the FIMS documentation for version 0.2.0.0.
Documentation list
-
Overview
Description: a summary of critical information (e.g., history of FIMS, organization overview, and technologies and tools used to build FIMS) and operating processes (< 2 pages). Links to additional resources (e.g., Term of reference, technical memos, and manuscripts) can be included in this summary. This document can serve as an initial resource for new team members, addressing fundamental questions they are likely to have.
-
Link:
- under development
-
C++ source code documentation
Description: use comments in the code to document C++ files, namespaces, classes, structs, templates, variables, functions, and typedefs.
-
Link:
-
R source code documentation
Description: describe R functions in comments next to their definitions.
-
Link:
-
Release notes
Description: provide notes associated with each release of FIMS.
-
Link:
-
License
Description: provide full copies of the license statements.
-
Link:
-
Case studies
Description: provide test cases of FIMS.
-
Link:
-
User guide
Description: describe the available installation options for FIMS. Provide step-by-step procedures for common beginner and advanced FIMS workflows.
-
Link:
-
Overview
Description: a summary of critical information (e.g., history of FIMS, organization overview, and technologies and tools used to build FIMS) and operating processes (< 2 pages). Links to additional resources (e.g., Term of reference, technical memos, and manuscripts) can be included in this summary. This document can serve as an initial resource for new team members, addressing fundamental questions they are likely to have.
-
Link:
- under development
Update frequency: update the document as requested, particularly if new members encounter difficulties resolving major issues or uncover misinformation while using this document.
-
Strategic plan
Description: define the mission, vision, and strategic plan for FIMS.
-
Link:
Update frequency: annually update the document at the end of NOAA’s fiscal year.
-
Requirements
Description: document the set of requirements requested by regional teams for inclusion in FIMS.
-
Link:
Update frequency: annually update the document at the end of NOAA’s fiscal year.
-
Developer guide
Description: this guide helps developers install, configure, and manage FIMS.
-
Link:
Update frequency: update the book as per request and bug report.
-
Design documents
Description: a summary of key decisions regarding the design and architecture of FIMS.
-
Link:
Update frequency: create the documentation as a design document at the beginning of a milestone, update design decisions throughout development within the milestone, archive it at the end of the milestone. Document design decisions that are not obvious, thereby avoiding needless refactoring in the future or rehashing previously made decisions. At the end of the milestone, we can summarize key pieces of the document and put them into the overview document.
-
C++ source code documentation
Description: use comments in the code to document C++ files, namespaces, classes, structs, templates, variables, functions, and typedefs.
-
Link:
Update frequency: always up to date.
-
R source code documentation
Description: describe R functions in comments next to their definitions.
-
Link:
Update frequency: always up to date.
-
Case studies
Description: provide test cases of FIMS.
-
Link:
Update frequency: publish test cases within milestone 2 and then update the website as requested.
-
Overview
Description: a summary of critical information (e.g., history of FIMS, organization overview, and technologies and tools used to build FIMS) and operating processes (< 2 pages). Links to additional resources (e.g., Term of reference, technical memos, and manuscripts) can be included in this summary. This document can serve as an initial resource for new team members, addressing fundamental questions they are likely to have.
-
Link:
- under development
Update frequency: update the document as requested, particularly if new members encounter difficulties resolving major issues or uncover misinformation while using this document.
-
Strategic plan
Description: define the mission, vision, and strategic plan for FIMS.
-
Link:
Update frequency: annually update the document at the end of NOAA’s fiscal year.
-
Overview
Description: a summary of critical information (e.g., history of FIMS, organization overview, and technologies and tools used to build FIMS) and operating processes (< 2 pages). Links to additional resources (e.g., Term of reference, technical memos, and manuscripts) can be included in this summary. This document can serve as an initial resource for new team members, addressing fundamental questions they are likely to have.
Audience: project manager, developer, and user
-
Link:
- under development
Update frequency: update the document as requested, particularly if new members encounter difficulties resolving major issues or uncover misinformation while using this document.
-
Strategic plan
Description: define the mission, vision, and strategic plan for FIMS.
Audience: project manager and developer
-
Link:
Update frequency: annually update the document at the end of NOAA’s fiscal year.
-
Requirements
Description: document the set of requirements requested by regional teams for inclusion in FIMS.
Audience: developer
-
Link:
Update frequency: annually update the document at the end of NOAA’s fiscal year.
-
Developer guide
Description: this guide helps developers install, configure, and manage FIMS.
Audience: developer
-
Link:
Update frequency: update the book as per request and bug report.
-
Design documents
Description: a summary of key decisions regarding the design and architecture of FIMS.
Audience: developer
-
Link:
Update frequency: create the documentation as a design document at the beginning of a milestone, update design decisions throughout development within the milestone, archive it at the end of the milestone. Document design decisions that are not obvious, thereby avoiding needless refactoring in the future or rehashing previously made decisions. At the end of the milestone, we can summarize key pieces of the document and put them into the overview document.
-
C++ source code documentation
Description: use comments in the code to document C++ files, namespaces, classes, structs, templates, variables, functions, and typedefs.
Audience: developer and user
-
Link:
Update frequency: always up to date.
-
R source code documentation
Description: describe R functions in comments next to their definitions.
Audience: developer and user
-
Link:
Update frequency: always up to date.
-
Release notes
Description: provide notes associated with each release of FIMS.
Audience: user
-
Link:
Update frequency: update before a release.
-
License
Description: provide full copies of the license statements.
Audience: user
-
Link:
Update frequency: review the license before a major version release and determine if any updates are necessary.
-
Case studies
Description: provide test cases of FIMS.
Audience: developer and user
-
Link:
Update frequency: publish test cases within milestone 2 and then update the website as requested.
-
User guide
Description: describe the available installation options for FIMS. Provide step-by-step procedures for common beginner and advanced FIMS workflows.
Audience: user
-
Link:
Update frequency: always up to date (The person making the change is responsible for the update and a dedicated user guide maintainer should check in on it at the end of each milestone).