search

open-design-kit / opendesignkit

Open Design Kit is a living toolkit for designing with distributed collaborators.
http://opendesignkit.org
Creative Commons Attribution 4.0 International
194 stars 79 forks source link

Revise the README to be more welcoming #61

Closed iamjessklein closed 8 years ago

iamjessklein commented 8 years ago

The current document was placeholder. Let's clean it up to be more welcoming and instructional. awesome-readme provides some great inspiration.

iamjessklein commented 8 years ago

I want to add a placeholder logo. For now I'll use this:

screen shot 2016-06-21 at 4 00 38 pm

We can update it when @isaacdurazo adjusts the design.

iamjessklein commented 8 years ago

I would prefer that a non - Bocouper give this issue a review. This way we can see if it makes sense to a larger audience.

iamjessklein commented 8 years ago

I also think that once @susanjrobertson gets to issue #64 it will be a lot more new user friendly.

dajbelshaw commented 8 years ago

Hey all, @iamjessklein asked me to copy/paste some feedback from a brief conversation on Slack.

OK, have read through. Good stuff, first paragraph is key.

Questions:

  1. Who are bocoup? (I may have never heard of you before)
  2. What is a design kit for?
  3. What difference does it make that it's 'open'? What does that mean?
  4. What level of expertise do I need to get the most out of this (and in what areas?)
  5. What does success look like?

I guess you'll end up with a frontend to this, in which case you'll probably want to differentiate between two audiences:

Finally, it may be worth keeping the first paragraph pretty terse and short, but linking to definitions of terms on the wiki?

vazquez commented 8 years ago

The How to Get Involved section could be a little bit friendlier. A lot of terms pop-up that might be confusing to a novice person in the industry. Terms like:

iamjessklein commented 8 years ago

Thanks @vazquez and @dajbelshaw - you are our first non-Bocoup contributors! We will add you to the contributors list.

I've made the following edits:

I still need to add to this section. I would love for someone with less technical skill to write it.

iamjessklein commented 8 years ago

Ok, I took a stab and added a bunch of steps for the how to contribute.

cc/ @susanjrobertson

bmac commented 8 years ago

Some thoughts on the readme:

It would be nice to see a short 1 sentence description next to the Hypotheses and Project Brief links in the Key Documents section. Maybe something like:

(These are just quick suggestions feel free to use whatever sentence is appropriate.)

There is no links to the wiki home page or the web site. Once I had gotten to the end of the readme, I was unsure of where to go next to learn more about the open design kit. The only links in the readme that go to the Open Design Kit point to the Hypotheses or Project Brief and neither of these pages direct the user onto another page in the Open Design Kit.

The terms "design literacy" and "design thinking" are used but never defined. As someone without a strong design background I'd like to know more about what these mean to the authors of the open design kit. However, this may be an issue with my background because I didn't not have the same reaction with the term "open source" which I realize may be unfamiliar to some of the audience.

The "What's the big idea?" broadly mentions several roles like designer, engineer, client and stakeholder and the challenges they have interacting with the design process. I found this interesting and wished there was a page when I could look and see that "my role is X" and I am expected to be involved in tools "Journey Maps" and "Interviews".

I know the "How to Use the Kit" says "There is no set order of operations for getting started with the kit" but I really wish that paragraph would direct me somewhere to start browsing the tools and practices.

iamjessklein commented 8 years ago

@pamela-drouin will be final signoff on this.

susanjrobertson commented 8 years ago

Closing, we can open new issues if we need to iterate on this as we see need for changes.