Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is there a glossary somewhere? New minds are overwhelmed. #51

Closed
alphahorse opened this issue May 26, 2020 · 4 comments
Closed

Is there a glossary somewhere? New minds are overwhelmed. #51

alphahorse opened this issue May 26, 2020 · 4 comments
Assignees

Comments

@alphahorse
Copy link

For people coming here who have no experience with Project Reunion, many of the threads may contain too much jargon to be very useful. Don't get me wrong - jargon has its place, as a compact way of expressing commonly-understood terms and concepts, but the key point here is "commonly-understood". In a quick scan through some initial threads, I saw many terms I didn't recognize; some I was able work out, some I found via old man google, but others are less clear: as an example, the use of the word "projection" as it appears here is unfamiliar to me, and I'm not sure that the meaning I've assigned to it is correct.

Normally, I would expect to find things that I, as a new arrival, might not understand in the FAQ, but to be honest, the FAQ is currently very, um, "sparse", and itself rather thick with unfamiliar terms. My request would be that someone put together a basic glossary of terminology and link it from the FAQ. This would certainly help me, and I'm sure would help other new arrivals as well - people who might otherwise be put off and leave.

I'd be happy to be a newbie guinea-pig and compile a short list of terms that could be usefully clarified if someone asks me to.

@jonwis
Copy link
Member

jonwis commented May 26, 2020

@alphahorse - please do add a comment with the set of terms you're interested in! @mevey or I will be happy to put together an update to the FAQ (or a new GLOSSARY.md) with them.

@Kade-N
Copy link

Kade-N commented May 31, 2020

Adding onto this, I think it could be very helpful to have a sort of "quick start" to help both those who are new altogether, and those who may not be 100% familiar with all the terminology and concepts used.

TypeScript does a fantastic job of this IMO, they have a brand new website that outlines exactly what TypeScript is, and how to get started, whether you are new to programming, or coming from another language like JavaScript, Java, or C#. https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html

I think this could be a good model for Project Reunion. There's been numerous issues in both this repo (#17 #30 #36 #40 #53) and some others (MAUI #47 #122) expressing confusion, and a lot of questions about how things relate to each other. A "get started" guide like how TypeScript has could be a good way to get everyone on the same page, no matter what background they come from.

Something structured like this basically:

  • Project Reunion for new programmers and/or students

    • What is Win32 (pros and cons)
    • What is UWP (pros and cons)
    • How Project Reunion unites them under a single platform
    • Quick explanation of C++ vs .NET (WPF/Forms/UWP) vs React/JS, how you can use any one to develop for Windows
      • Links off to other tutorials, like UWP
      • Needs to be clear that Project Reunion is not a way to develop apps - aka "go develop these somewhere else, then come back and read the appropriate next section to learn how to take advantage of Project Reunion" - as this seems like an easy point of confusion
  • Project Reunion for Win32 developers

    • What is Project Reunion
    • What components are available, how they can be useful, etc...
  • Project Reunion for UWP developers

  • Project Reunion for React developers

    • What is Project Reunion
    • Bringing apps to Windows
    • Using new components, how they can be useful, etc...

That's just a quick skeleton off the top of my head - I'm not sure how much of this is actually feasible, and it doesn't necessarily need to be full articles like TS has, but I think a tailored approach would definitely be a good way to go.

Best to separate out students, UWP fans, longtime Windows developers, and developers from other platforms, since from my experiences in a couple of MS repos here, these are very different groups, with different needs.

@stevewri
Copy link
Contributor

@mevey can you take point? Several of us could collaborate on the content.

@mevey
Copy link
Contributor

mevey commented Jul 21, 2020

I've started a Glossary wiki page that we will develop more.
@KyleNanakdewa You make some great suggestions and we are working to make sure that the docs, FAQ and Glossary can be informative for all categories of Windows developers.

@mevey mevey assigned mevey and unassigned mevey Jul 29, 2020
@ghost ghost added the needs-attention 👋 label Sep 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants