[INFRA-68] Prepare abbreviation list Created: 03/Nov/16  Updated: 02/Jun/17  Resolved: 02/Jun/17

Status: Done
Project: Software Development Infrastructure
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major
Reporter: yuki.moritani Assignee: yuki.moritani
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

PFS has a lot of abbreviations.
Summarise the these words and create a list.

It is desirable that the list has nor only the full words of each abbreviation, but also category, and short description.

 Comments   
Comment by yuki.moritani [ 03/Nov/16 ]

I made a draft:
https://github.com/Subaru-PFS/doc/pull/5

The abbreviations are gathered from PFS documents such as design reviews, product trees, fundamental performance requirements, as well as Atsushi's documents.

Comment by shimono [ 04/Nov/16 ]

PR branch shall start from master except for special reason.
Rebase current PR branch, or create new one.

Comment by yuki.moritani [ 04/Nov/16 ]

Sorry... done

Comment by shimono [ 17/Nov/16 ]

do we have PR for this? branch seems existing.

Comment by yuki.moritani [ 17/Nov/16 ]

I apologize:

Just created:
https://github.com/Subaru-PFS/doc/pull/6

Comment by shimono [ 17/Nov/16 ]

Not reviewing individual items here (file new ticket to correct items), but just from organization point of view.

  • consider to add note in top page (README.md)
  • rather than setting 'Subcomponent' to more than half, how about to set name for one level upper, like FPSA -> FSA
  • many of ICS component named as the same as hardware to control, and some software component is in hardware category, we may be better to think about them (but no idea now)
Comment by yuki.moritani [ 07/Apr/17 ]

I'm sorry for delaying my comment so long time...

  • I'll add README.md . I apologize for it.
  • As I talked directly, I don't mean hierarchy using group and category. I should rename "group" and "category" to more proper words.
Comment by shimono [ 17/Apr/17 ]

I don't have any further comment.

Although I may insist to add a feature to make building hierarchy possible, but that shall be new feature request, once initial version released...

Comment by yuki.moritani [ 24/May/17 ]

I have just updated initial version with comments of individual abbreviations. (in the the same PR)
While I was writing, I thought it would be better to have one column where related institutes are described...

Comment by shimono [ 31/May/17 ]

(how about to merge PR, since no comment in one week?)

Comment by yuki.moritani [ 31/May/17 ]

All right. I've merged it.
I hope each description can be updated at proper stage.

Comment by shimono [ 02/Jun/17 ]

PR merged, closing this.

Generated at Sat Feb 10 16:49:05 JST 2024 using Jira 8.3.4#803005-sha1:1f96e09b3c60279a408a2ae47be3c745f571388b.