Skip to content

Commit 2a80b69

Browse files
document's name convention
1 parent 14bbe65 commit 2a80b69

10 files changed

Lines changed: 8 additions & 50 deletions

File tree

opensilex-doc/src/main/resources/functional-specifications/facility_monitoring.md renamed to opensilex-doc/src/main/resources/functional-specifications/facility-monitoring.md

File renamed without changes.

opensilex-doc/src/main/resources/functional-specifications/germplasms_import_specs.md renamed to opensilex-doc/src/main/resources/functional-specifications/germplasms-import.md

File renamed without changes.

opensilex-doc/src/main/resources/functional-specifications/global_map.md renamed to opensilex-doc/src/main/resources/functional-specifications/global-map.md

File renamed without changes.

opensilex-doc/src/main/resources/functional-specifications/global_uri_search.md renamed to opensilex-doc/src/main/resources/functional-specifications/global-uri-search.md

File renamed without changes.

‎opensilex-doc/src/main/resources/functional-specifications/index.md‎

Lines changed: 0 additions & 47 deletions
This file was deleted.

opensilex-doc/src/main/resources/functional-specifications/map_Clusters_SO.md renamed to opensilex-doc/src/main/resources/functional-specifications/map-Clusters-SO.md

File renamed without changes.

opensilex-doc/src/main/resources/functional-specifications/map_Export_shapefiles_geoJson.md renamed to opensilex-doc/src/main/resources/functional-specifications/map-Export-shapefiles-geoJson.md

File renamed without changes.

opensilex-doc/src/main/resources/functional-specifications/scientific_objects_import.md renamed to opensilex-doc/src/main/resources/functional-specifications/scientific-objects-import.md

File renamed without changes.

opensilex-doc/src/main/resources/functional-specifications/template/spec_template.md renamed to opensilex-doc/src/main/resources/functional-specifications/template/spec-template.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
This document is a template for writing specifications for a particular feature. Please copy-paste
22
it into your own file. Please edit the first line of the **document history** table. Please fill
33
the _WARNING_ annotation if the document is not exhaustive; you can remove it if the specification treats
4-
all topics concerning the feature.
4+
all topics concerning the feature. Please name the document without uppercase nor spaces nor underscore, use
5+
hyphens if for spaces (e.g. my-feature-specifications.md).
56

67
Each section of the template is optional. If a section is not relevant for the specification of the
78
feature, feel free to remove it. You can change the order of sections, and add new sections if you
89
need it. All texts in {curly braces} are meant to be replaced. Before making a commit of your changes,
910
please update the table of contents (you can do this automatically with your IDE).
1011

11-
These first three paragraphs of this template are to be removed before publishing your specification.
12+
Specifications documents are not intended to contain technical details. They should focus on the needs from a user
13+
perspective. The Business logic section is a very detailed description of the rules that must be applied to implement
14+
the feature, but always from a user perspective. Technical details should be in technical documentation, not in specifications.
15+
16+
These first four paragraphs of this template are to be removed before publishing your specification.
1217

1318
# Specifications : [{category}] {title}
1419

‎opensilex-doc/src/main/resources/technical-documentation/opensilex-core/germplasms/germplasms_import.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
## functional requirements
3131

3232
**functional specification** : to understand the purpose of the feature and its precise rules see relative functional specification file :
33-
- [germplasms_import_specs.md](../../../functional-specifications/germplasms_import_specs.md)
33+
- [germplasms-import.md](../../../functional-specifications/germplasms-import.md)
3434

3535
## Non-functional requirements
3636

0 commit comments

Comments
 (0)