Skip to content

Commit

Permalink
First cut at real examples from SWEBOK
Browse files Browse the repository at this point in the history
Thanks to Timo for the data!
  • Loading branch information
bernhold committed Jun 24, 2024
1 parent bec0da6 commit e8a71e8
Show file tree
Hide file tree
Showing 10 changed files with 523 additions and 16 deletions.
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ plugins:
# - vendor/gems/
# - vendor/ruby/
# - README.md
exclude:
- fundamentals.txt

repository: ser-rse-bridge/mapping-of-terms

Expand Down
92 changes: 80 additions & 12 deletions _layouts/term.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,110 @@

<h2>Terms</h2>

<table style="width:100%">
<table>
<thead>
<tr>
<th style="width:50%">SE Fundamental</th><th style="width:50%">RSE Equivalent</th>
<th style="width:50%">SE Fundamental</th>
<th style="width:50%">RSE Equivalent</th>
</tr>
</thead>
<tbody>
<tr>
<td>{% include array_to_ul.html array=page.se_fundamental %}</td><td>{% include array_to_ul.html array=page.rse_equivalent %}</td>
<td>{% if page.se_fundamental and page.se_fundamental != empty %}
{% include array_to_ul.html array=page.se_fundamental %}
{% else %}
<em style="color:red">Not provided</em>
{% endif %}
</td>
<td>{% if page.rse_equivalent and page.rse_equivalent != empty %}
{% include array_to_ul.html array=page.rse_equivalent %}
{% else %}
<em style="color:red">Not provided</em>
{% endif %}
</td>
</tr>
</tbody>
</table>

<h2>Details</h2>
<table>
<tr>
<td>SWEBOK section</td><td>{{ page.swebok_section }}</td>
<td>SWEBOK section</td>
<td>{% if page.swebok_section and page.swebok_section != empty %}
{{ page.swebok_section }}
{% else %}
<em style="color:red">Not provided</em>
{% endif %}
</td>
</tr>
<tr>
<td>Fundamental description</td><td>{{ page.fundamental_description }}</td>
<td>Fundamental description</td>
<td>{% if page.fundamental_description and page.fundamental_description != empty %}
{{ page.fundamental_description }}
{% else %}
<em style="color:red">Not provided</em>
{% endif %}
</td>
</tr>
<tr>
<td>RSE practice</td><td>{{ page.rse_practice }}</td>
<td>RSE practice</td>
<td>{% if page.rse_practice and page.rse_practice != empty %}
{{ page.rse_practice }}
{% else %}
<em style="color:red">Not provided</em>
{% endif %}
</td>
</tr>
<tr>
<td>RSE awareness (source)</td><td>{{ page.rse_awareness }} ({{ page.rse_awareness_source }})</td>
<td>RSE&nbsp;awareness&nbsp;(source)</td>
<td>{%- if page.rse_awareness and page.rse_awareness != empty -%}
{{ page.rse_awareness }}
{%- else -%}
<em style="color:red">Not provided</em>
{%- endif -%}
{%- if page.rse_awareness_source and page.rse_awareness_source != empty -%}
&nbsp;({{ page.rse_awareness_source }})
{%- else -%}
<em style="color:red">&nbsp;(Not provided)</em>
{%- endif -%}
</td>
</tr>
<tr>
<td>RSE usage (source)</td><td>{{ page.rse_usage }} ({{ page.rse_usage_source }})</td>
<td>RSE&nbsp;usage&nbsp;(source)</td>
<td>{%- if page.rse_usage and page.rse_usage != empty -%}
{{ page.rse_usage }}
{%- else -%}
<em style="color:red">Not provided</em>
{%- endif -%}
{%- if page.rse_usage_source and page.rse_usage_source != empty -%}
&nbsp;({{ page.rse_usage_source }})
{%- else -%}
<em style="color:red">&nbsp;(Not provided)</em>
{%- endif -%}
</td>
</tr>
<tr>
<td>SER potential (source)</td><td>{{ page.ser_potential }} ({{ page.ser_potential_source }})</td>
</tr>
<tr>
<td>SER opportunities</td><td>{{ page.ser_opportunities }}</td>
<td>SER&nbsp;potential&nbsp;(source)</td>
<td>{%- if page.ser_potential and page.ser_potential != empty -%}
{{ page.ser_potential }}
{%- else -%}
<em style="color:red">Not provided</em>
{%- endif -%}
{%- if page.ser_potential_source and page.ser_potential_source != empty -%}
&nbsp;({{ page.ser_potential_source }})
{%- else -%}
<em style="color:red">&nbsp;(Not provided)</em>
{%- endif -%}
</td>
</tr>
<tr>
<td>SER opportunities</td>
<td>{% if page.ser_opportunities and page.ser_opportunities != empty %}
{{ page.ser_opportunities }}
{% else %}
<em style="color:red">Not provided</em>
{% endif %}
</td>
</table>

{% if page.references and page.references != empty %}
Expand Down
43 changes: 43 additions & 0 deletions _terms/1.3-requirements-elicitation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
# array of synonyms or adjacent concepts
se_fundamental:
- Requirements elicitation

# Short (1 sentence) description of the SE fundamental -- as a convenience
fundamental_description: |
Concerned with the source of software requirements (e.g., goals, domain knowledge, stakeholders, environment) and how to collect them using elicitation techniques (e.g., interviews, scenarios, prototypes, observation, user stories).
#
# Seems to need quotes, unfortunately
swebok_section: 1.3

# array of synonyms or adjacent concepts
# need a way of specifying that it is the same as the se_fundamental
rse_equivalent:

# Text, a brief description of the typical realizations of the fundamental, in RSE practice
rse_practice:

# General level of awareness of the fundamental in the research software community
# integers 0-3, 0=effectively no awareness, 3=widespread awareness; -1=no estimate
rse_awareness:
rse_awareness_source:

# General level of usage of the fundamental in the research software community
# integers 0-3, 0=effectively no usage, 3=widespread use; -1=no estimate
rse_usage:
rse_usage_source:

# Potential for SE research to improve use in research software
# integers 0-3, 0=effectively no opportunity, 3=significant SE research beneficial; -1=no estimate
ser_potential:
ser_potential_source:

# Reasons/opportunities for the SE research
ser_opportunities:

# References (external links, papers, etc., that may provide useful connections)
references:

# Date of last review by the editorial board
last_reviewed: 1970-01-01
---
43 changes: 43 additions & 0 deletions _terms/1.4-requirements-analysis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
# array of synonyms or adjacent concepts
se_fundamental:
- Requirements analysis

# Short (1 sentence) description of the SE fundamental -- as a convenience
fundamental_description: |
Concerned with the process of analyzing requirements to detect and resolve conflicts between requirements, and to discover the bounds of the software and how it must interact with its environment. May include requirements classification, conceptual modeling, and requirements negotiation. The level of formality may range from natural text to precise mathematical notations.
#
# Seems to need quotes, unfortunately
swebok_section: 1.4

# array of synonyms or adjacent concepts
# need a way of specifying that it is the same as the se_fundamental
rse_equivalent:

# Text, a brief description of the typical realizations of the fundamental, in RSE practice
rse_practice:

# General level of awareness of the fundamental in the research software community
# integers 0-3, 0=effectively no awareness, 3=widespread awareness; -1=no estimate
rse_awareness:
rse_awareness_source:

# General level of usage of the fundamental in the research software community
# integers 0-3, 0=effectively no usage, 3=widespread use; -1=no estimate
rse_usage:
rse_usage_source:

# Potential for SE research to improve use in research software
# integers 0-3, 0=effectively no opportunity, 3=significant SE research beneficial; -1=no estimate
ser_potential:
ser_potential_source:

# Reasons/opportunities for the SE research
ser_opportunities:

# References (external links, papers, etc., that may provide useful connections)
references:

# Date of last review by the editorial board
last_reviewed: 1970-01-01
---
43 changes: 43 additions & 0 deletions _terms/1.5-requirements-specification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
# array of synonyms or adjacent concepts
se_fundamental:
- Requirements specification

# Short (1 sentence) description of the SE fundamental -- as a convenience
fundamental_description: |
Concerned with producing a document that can be systematically reviewed, evaluated, and approved. Software requirements are often specified in natural language, but may be supplemented by formal or semi-formal descriptions.
#
# Seems to need quotes, unfortunately
swebok_section: 1.5

# array of synonyms or adjacent concepts
# need a way of specifying that it is the same as the se_fundamental
rse_equivalent:

# Text, a brief description of the typical realizations of the fundamental, in RSE practice
rse_practice:

# General level of awareness of the fundamental in the research software community
# integers 0-3, 0=effectively no awareness, 3=widespread awareness; -1=no estimate
rse_awareness:
rse_awareness_source:

# General level of usage of the fundamental in the research software community
# integers 0-3, 0=effectively no usage, 3=widespread use; -1=no estimate
rse_usage:
rse_usage_source:

# Potential for SE research to improve use in research software
# integers 0-3, 0=effectively no opportunity, 3=significant SE research beneficial; -1=no estimate
ser_potential:
ser_potential_source:

# Reasons/opportunities for the SE research
ser_opportunities:

# References (external links, papers, etc., that may provide useful connections)
references:

# Date of last review by the editorial board
last_reviewed: 1970-01-01
---
44 changes: 44 additions & 0 deletions _terms/1.6-requirements-validation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
# array of synonyms or adjacent concepts
se_fundamental:
- Requirements validation

# Short (1 sentence) description of the SE fundamental -- as a convenience
fundamental_description: |
Examines the requirements specification to ensure that it defines the right software (e.g., the software that the users expect). May be done by inspection or reviews, (rapid) prototyping, or model analysis, depending on the methods used for requirements specification.
#
# Seems to need quotes, unfortunately
swebok_section: 1.6

# array of synonyms or adjacent concepts
# need a way of specifying that it is the same as the se_fundamental
rse_equivalent:

# Text, a brief description of the typical realizations of the fundamental, in RSE practice
rse_practice:

# General level of awareness of the fundamental in the research software community
# integers 0-3, 0=effectively no awareness, 3=widespread awareness; -1=no estimate
rse_awareness:
rse_awareness_source:

# General level of usage of the fundamental in the research software community
# integers 0-3, 0=effectively no usage, 3=widespread use; -1=no estimate
rse_usage:
rse_usage_source:

# Potential for SE research to improve use in research software
# integers 0-3, 0=effectively no opportunity, 3=significant SE research beneficial; -1=no estimate
ser_potential:
ser_potential_source:

# Reasons/opportunities for the SE research
ser_opportunities:

# References (external links, papers, etc., that may provide useful connections)
references:


# Date of last review by the editorial board
last_reviewed: 1970-01-01
---
44 changes: 44 additions & 0 deletions _terms/1.7.4-requirements-tracing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
# array of synonyms or adjacent concepts
se_fundamental:
- Requirements tracing
- traceability

# Short (1 sentence) description of the SE fundamental -- as a convenience
fundamental_description: |
A requirement should be traceable backward to its source and forward to its implementing design entities.
#
# Seems to need quotes, unfortunately
swebok_section: 1.7.4

# array of synonyms or adjacent concepts
# need a way of specifying that it is the same as the se_fundamental
rse_equivalent:

# Text, a brief description of the typical realizations of the fundamental, in RSE practice
rse_practice:

# General level of awareness of the fundamental in the research software community
# integers 0-3, 0=effectively no awareness, 3=widespread awareness
rse_awareness:
rse_awareness_source:

# General level of usage of the fundamental in the research software community
# integers 0-3, 0=effectively no usage, 3=widespread use
rse_usage:
rse_usage_source:

# Potential for SE research to improve use in research software
# integers 0-3, 0=effectively no opportunity, 3=significant SE research beneficial
ser_potential:
ser_potential_source:

# Reasons/opportunities for the SE research
ser_opportunities:

# References (external links, papers, etc., that may provide useful connections)
references:

# Date of last review by the editorial board
last_reviewed: 1970-01-01
---
44 changes: 44 additions & 0 deletions _terms/1.8-requirements-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
# array of synonyms or adjacent concepts
se_fundamental:
- Requirements tools

# Short (1 sentence) description of the SE fundamental -- as a convenience
fundamental_description: |
Support the requirements management through modeling, documentation, tracing, change management, etc.
#
# Seems to need quotes, unfortunately
swebok_section: 1.8

# array of synonyms or adjacent concepts
# need a way of specifying that it is the same as the se_fundamental
rse_equivalent:

# Text, a brief description of the typical realizations of the fundamental, in RSE practice
rse_practice:

# General level of awareness of the fundamental in the research software community
# integers 0-3, 0=effectively no awareness, 3=widespread awareness; -1=no estimate
rse_awareness:
rse_awareness_source:

# General level of usage of the fundamental in the research software community
# integers 0-3, 0=effectively no usage, 3=widespread use; -1=no estimate
rse_usage:
rse_usage_source:

# Potential for SE research to improve use in research software
# integers 0-3, 0=effectively no opportunity, 3=significant SE research beneficial; -1=no estimate
ser_potential:
ser_potential_source:

# Reasons/opportunities for the SE research
ser_opportunities:

# References (external links, papers, etc., that may provide useful connections)
references:
- IBM DOORS

# Date of last review by the editorial board
last_reviewed: 1970-01-01
---
Loading

0 comments on commit e8a71e8

Please sign in to comment.