search

vrk-kpa / xroad-joint-development

Unmaintained repository. Development moved to: https://github.com/nordic-institute/X-Road-development
19 stars 8 forks source link

Add reference to Terms of X-Road document #207

Closed hanhaka closed 6 years ago

VitaliStupin commented 6 years ago

What about existing documents? Do we need to remove terms and abbreviations? For example it is a lot easier to read a protocol document which defines a couple of terms needed for better understanding of that document, then to just have a reference to a terms document that has a lot of unnecessary stuff.

hanhaka commented 6 years ago

Originally I was thinking that terms and abbreviations section would be removed from all the existing documents. But after reading your comment and re-thinking the matter, it would be better if the terms that are specific for the document in question would be defined in that document itself (it makes reading a lot easier) and only general X-Road related terms and abbreviations would be moved to Terms of X-Road document.

I will rephrase the text in FormattingStyleGuide.md and make a new commit.

hanhaka commented 6 years ago

This is though one :) ...made a new commit to clarify more how to define terms and abbreviations in documents.