Styleguide - Githubissues

International-Data-Spaces-Association / IDS-RAM_4_0

Focusing on the generalization of concepts, functionality, and overall processes involved in the creation of a secure 'network of trusted data' , the IDS-RAM resides at a higher abstraction level than common architecture models of concrete software solutions do. The document provides an overview and dedicated architecture specifications.

Creative Commons Attribution 4.0 International

38 stars 27 forks source link

Styleguide #107

Closed mokamhuber closed 1 year ago

mokamhuber commented 2 years ago

lets define styles for consistent usage and guidelines for contributing:

How to use different terminology, e.g., always writing "IDS Connector", "IDS MetaData Broker", ...
How to handle links
Always put sources for images into a media folder
...

mokamhuber commented 2 years ago

For links: use Markdown references to the other chapters/sections wherever necessary

mokamhuber commented 2 years ago

Purpose of images in the repo: graphics shall focus on content and illustrate information - for the PDF version of RAM 4.0 a designers will beautify and align them

HeinrichPet commented 2 years ago

Use Draw.io for figures
Figures and draw.io sources should be located in a /media/ folder inside the folder of the corresponding .md file
Business Layer chapter should mainly use BPMN graphics, whereas Process Layer should mainly use Sequence Diagrams
Do not name technologies no tools #27

HeinrichPet commented 2 years ago

Number the figures according to the section number. For example in section 3.5.2.0 the figures are numbered 3.5.2.0.1, 3.5.2.0.2, ...

ssteinbuss commented 1 year ago

Closed by #193