icipe-official / icipe-official/vectoratlas-software-code
Include list or dictionary of used acronyms
@Vansnoden is already working on this.
Since Jan 30, 2023.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 8
- Avg merge
- 5d 4h
- Merged PRs (30d)
- 11
Description
Collect together any fields in the database that could be considered ambiguous - acronyms, compressed titles etc. - and create a list or dictionary describing these terms. What does it stand for and what does it mean? Where this is to be placed should be discussed when first picking up the story but, an initial suggestion is to include it in the help page documentation.
From there, it should act as a quick source of reference for those unsure of the terminologies or acronyms used in the system.
Bear in mind, the models are yet to be implemented and there may be a number of elements within that will require similar treatment. Furthermore, not all fields will require this - for example, country is unambiguous and committing time to including it would not be worthwhile. However, a field like a dec_check should require further clarification
AC's:
- Some source detailing the meaning of acronyms, and otherwise vague fields, that is accessible and obvious to the user
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.