Draft Software Planning for Data Management Framework #46
Conversation
dadamsncsa
requested review from
danielskatz,
elifleaf,
greghbauer,
hayden-taylor and
tawfick
| # nanoMFG Software Planning Document | ||
| <!-- Replace text below with long title of project:short-name --> | ||
| ## nanoMFG Data Management Framework | ||
| ### Target Release: #.#.# : Month Day, 20## |
There was a problem hiding this comment.
this level of detail in a target seems very optimistic
| **nanoHUB Group(s):** | ||
|
|
||
| ## 1. Introduction | ||
|
|
There was a problem hiding this comment.
maybe something should go here with a very brief statement of the tool and a very general description of what it's for and who the users are intended to be? e.g., This is cooltool, which simulates the process of manufacturing ... and should be useful for experimentalists who want to simulate this process many times to select good parameters before they actually run more costly physical experiments
There was a problem hiding this comment.
Or maybe this is part of what you have as 1.1, but I think could be 1.0...
| --> | ||
| The first version of the DMf is intended to provide experimental labs working with 2D materials with framework to describe, catalog, analyse and publish data. | ||
|
|
||
| ##### Relationship to Existing Software |
| ##### Relationship to Existing Software | ||
| Seems there are a number of commertional options for scientific data management software (SDMS) | ||
|
|
||
| ##### Our Approach |
| ##### Our Approach | ||
|
|
||
| ### 1.2 References | ||
| <!--List any documents or background material that are relevant. Links are useful. For instance, a link to a wiki or readme page in the project repository, or link to a uploaded file (doc, pdf, ppt, etc.).--> |
There was a problem hiding this comment.
is a section needed for this, or would these references be in-line in previous subsections?
| <!--Provide context for the proposed product. Is this a completely new projects, or next version of an existing project? This can include a description of any contextual research, or the status of any existing prototype application. If this SPD describes a component, describe its relationship to larger system. Can include diagrams.--> | ||
|
|
||
| ### 2.2 Scope and Limitations for Current Release | ||
| <!--List the all planned goals/features for this release. These should be links to issues. Add a new subsection for each release. Equally important, document feature you explicity are not doing at this time--> |
There was a problem hiding this comment.
| <!--List the all planned goals/features for this release. These should be links to issues. Add a new subsection for each release. Equally important, document feature you explicity are not doing at this time--> | |
| <!--List the all planned goals/features for this release. These should be links to issues. Add a new subsubsection for each release. Equally important, document feature you explicity are not doing at this time--> |
|
|
||
| ### 3.1 Classes of Users | ||
| <!--Identify classes (types) of users that you anticipate will use the product. Provide any relevant context about each class that may influence how the product is used: | ||
| The tasks the class of users will perform |
There was a problem hiding this comment.
maybe also how they do those tasks now, if they do, and how this will be an improvement?
No description provided.