National-COVID-Cohort-Collaborative / guide-to-n3c-v1

Research with the National COVID Cohort Collaborative (N3C: https://ncats.nih.gov/n3c)
https://national-covid-cohort-collaborative.github.io/guide-to-n3c-v1/
Other
11 stars 4 forks source link

Section 11.5, a bit awkward #224

Open chrisroederucdenver opened 2 months ago

chrisroederucdenver commented 2 months ago

I found it a bit awkward to read about the "training area" and then contrastingly the "practice area". Once you find it, it's clear the project is called the "N3C Training Area", and the folder within is the "Practice Area - Public and Example Data". Admittedly, I'm racing through impatiently looking for the right place. When creating a workbook, rather than navigating with the Files tool, with the practice area in mind, you first have to go to the training area workspace.

Screenshot 2024-04-23 at 12 11 34 PM

Screenshot 2024-04-23 at 12 05 17 PM

Thinking about how to improve this, one way is to consider the workflow. Either document the "new workbook" flow, or direct people away from that to the Files workflow.

One thing that helps my way of thinking is seeing the two names together in the same context, like the paths you create when browsing, like "/Unite/N3C Training Area/Practice Area - Public and Example Data" I'm aware of and sensitive to my training and experience with command lines, but the path really doesn't take a new form here. It's still text.

oneilsh commented 1 month ago

@chrisroederucdenver I think renaming the "N3C Training Area" workspace may be tricker than renaming the folder inside; what about "Practice Folder - Public and Example Data"?

chrisroederucdenver commented 1 month ago

Tanks for looking at my issue ticket. My workflow and impatience dont' make this any easier.

In the book's workflow, it describes the task of creating a new folder in a context where you plan on creating a workbook as a second step. That single, first step is accomplished in the "Projects and Files" "Finder" (Mac) or "File Manager" (Windows) app. It requires forethought.

My workflow has been to create a new workbook and then wonder where to save it when the dialog in the Workbook tool asks. More on that in another comment below.

The existing text, for the first workflow, might be improved by changing from : If you wish to create a practice folder, you are free to do so inside the “Practice Area - Public and Example Data”. Simply open it up, and using the green +New button create a new subfolder with a unique name (many use shortened usernames, e.g., “oneils”). Within this folder you will be able to create new analyses, and these will have access to the notional datasets described next.

To something like: If you wish to create a practice folder, Start with the <finder tool> in the "N3C Practice Area" workspace where you are free to do so inside the “Practice Area - Public and Example Data”. Simply open it up, and using the green +New button create a new subfolder with a unique name (many people use shortened usernames, e.g., “oneils”). Within this folder you will be able to create new analyses, and these will have access to the notional datasets described next.

It makes skimming for information a little better (for me) because the information is all there in the same sentence.

Also, my setup has the finder-thingy as "Files" not "Projects and Files". Looking to write this, I'm amazed to see how useful it is, especially since the training area is indeed right there in front of my eyes. Screenshot 2024-05-16 at 3 28 41 PM

2nd workflow discussed in next comment.

chrisroederucdenver commented 1 month ago

My workflow for creating a new workbook, which might need to be in the practice area workspace, is to start with the workbook tool and get faced with the dialog above (in this issue, not the guide). There, you have to remember the details of the name here: its the Training Area workspace, then the "Practice Area" folder within it.

Since the practice area is a place where someone is very likely to go when first learning a tool, mentioning the names of the workspace and practice area here and that workflow, especially how (I htink) you get stuck if you haven't created a folder yet, makes sense here. AND NOW I SEE how good a choice you made for the folder name!!!

Thanks. I hope this helps make the book better. I learned a lot just writing these comments.