Studio:Folder Layout: Difference between revisions
Jump to navigation
Jump to search
(New page: Category:STRIDE Workspace Best Practices) |
m (Text replace - 'Category:Project Organization' to 'Category:Studio:Project Organization') |
||
(14 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
[[Category: | This article outlines standards for placement of STRIDE solution files and folders. | ||
=Folder Layout= | |||
<Solution Root> | |||
[[#Documents|Documents]] ''-- relevant documents'' | |||
[[#Customer|Customer]] | |||
[[#S2|S2]] | |||
[[#Source|Source]] ''-- customer target source'' | |||
[[#Target|Target]] ''-- instrumented target binary and STRIDE database'' | |||
[[#TestAssets|TestAssets]] ''-- test assets'' | |||
[[#Doc|Doc]] | |||
[[#TestWorkspace|TestWorkspace]] | |||
[[#TestUnits|TestUnits]] | |||
[[#TestScripts|TestScripts]] | |||
[[#SCL|SCL]] | |||
[[#UtilityScripts|UtilityScripts]] | |||
=Folder Contents= | |||
== Documents == | |||
;Customer | |||
:<ul><li>customer-supplied documents that are not included or linked on the project portal wiki</li></ul> | |||
;S2 | |||
:<ul><li>S2-generated documents that are not included or linked in the project portal wiki</li><li>S2-generated documents that have been uploaded to the project portal wiki and embedded in a wiki page. (e.g. Visio drawings, screen shots, etc.)</li></ul> | |||
==Source== | |||
Customer source code required to build the target is stored here. | |||
Subfolder organization should follow that used by the customer. | |||
==Target== | |||
Local target app built from Visual Studio (customer source + IM) | |||
and STRIDE database (.sidb) built from [[STRIDE Studio]]. | |||
==TestAssets== | |||
Note: If there are multiple components, each requiring a unique set of TestAssets, than a sub-folder should be created representing the name of the component under test. | |||
The following hierarchy is recommended: | |||
;Doc | |||
: Test assets code documentation goes here. This folder is created and used automatically by the CreateDocs.pl script. | |||
;TestWorkspace | |||
: STRIDE workspace (.ssw) file goes here | |||
;TestUnits | |||
: If the workspace has test units defined, source files go here | |||
;TestScripts | |||
: Test scripts | |||
;SCL | |||
: Header files comprising this project's SCL go here as well as any s2instrument option files | |||
;UtilityScripts | |||
: Non-shared helper scripts and modules go here | |||
[[Category:Studio:Project Organization]] |
Latest revision as of 22:33, 20 August 2009
This article outlines standards for placement of STRIDE solution files and folders.
Folder Layout
<Solution Root> Documents -- relevant documents Customer S2 Source -- customer target source Target -- instrumented target binary and STRIDE database TestAssets -- test assets Doc TestWorkspace TestUnits TestScripts SCL UtilityScripts
Folder Contents
Documents
- Customer
- customer-supplied documents that are not included or linked on the project portal wiki
- S2
- S2-generated documents that are not included or linked in the project portal wiki
- S2-generated documents that have been uploaded to the project portal wiki and embedded in a wiki page. (e.g. Visio drawings, screen shots, etc.)
Source
Customer source code required to build the target is stored here.
Subfolder organization should follow that used by the customer.
Target
Local target app built from Visual Studio (customer source + IM) and STRIDE database (.sidb) built from STRIDE Studio.
TestAssets
Note: If there are multiple components, each requiring a unique set of TestAssets, than a sub-folder should be created representing the name of the component under test.
The following hierarchy is recommended:
- Doc
- Test assets code documentation goes here. This folder is created and used automatically by the CreateDocs.pl script.
- TestWorkspace
- STRIDE workspace (.ssw) file goes here
- TestUnits
- If the workspace has test units defined, source files go here
- TestScripts
- Test scripts
- SCL
- Header files comprising this project's SCL go here as well as any s2instrument option files
- UtilityScripts
- Non-shared helper scripts and modules go here