Giter VIP home page Giter VIP logo

devs-guide-to's Introduction

Dev's guide to...

This is the repo for 'A dev's (developer's) guide to...', as part of the USABLE tools project. On this microsite, you can find a series of resources with topics in: design collaboration, user testing, usability, synthesis and more. We decided to make the process of design more accessible and visible by documenting tangible, actionable ways of interacting with users with the goal to unlock the value of design.

USABLE resources focus on supporting maintainers of OSS, developer contributors, and OSS tool teams so that they can create more user-centered tools.

There are currently four resources for the USABLE project: User testing can be fun: An FAQ for small open source teams, A dev's guide to user testing: A roadmap for open source teams , Synthesis for open source, and Developer and Design collaboration in OSS.

You can visit the Github Pages website here: devs-guide-to

USABLE is a collaboration between Superbloom, formally Simply Secure, Okthanks, and Internews.

If you want to contribute a Pull Request to improve the resources or log a bug you can do that by raising a Pull Request and Opening an issue.

devs-guide-to's People

Contributors

duncanbeevers avatar erioldoesdesign avatar eriolhugotest avatar georgiamoon avatar kelseysmithdesign avatar oilsinwater avatar saptaks avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

devs-guide-to's Issues

Re-add the UX Forum post

We removed the UX forum post to fix a build error in the site and now we need to re-add it :)

Improve 'pull quote' styling - add a coloured bg to the text for contrast

The current pull quote style in the Hugo template isn't very visually striking or different to the body text:
Screenshot 2022-08-15 at 11 19 35

I think the twitter shortcode style works better for pullquotes:

Screenshot 2022-08-15 at 11 20 50

Test out the twitter shortcode style for the style of the 'pull quote'. See if a border and a bg colour make them more 'standout'

Test out more legible fonts

See what changing to a less 'typewriter' font looks like across the microsite. Does it improve legibility? test out some dyslexia friendly fonts and ensure they are OSS fonts.

Feedback from devs and OSS tool teams for 'A devs guide to...'

Here is where devs and OSS tool teams can add feedback for the microsite https://simplysecure.github.io/devs-guide-to/. Please add you feedback in a comment so that all feedback is collected in a single place ready to be read, understood, discussed and triaged by the 'devs guide to...' team.


Please add your feedback in an individual comment on this issue. You'll need to be logged into a Github account in order to offer feedback and you can edit comments after you've posted. Our guiding questions are:

  • What topics or sections were most useful? Why?
  • How could the resource microsite be improved (content or design)?
  • What was confusing or hard to understand?
  • What guides or resources would you like to see added?

email to request developers/tool teams review of the microsite content etc

  • Ask for tool teams and devs to review of the microsite site. https://simplysecure.github.io/devs-guide-to/

  • In email, invite the tool teams/devs to answer the following questions to frame the feedback:
    - What did you like?
    - What did you not like?
    - What was hard to understand?
    - Where did you need more examples?
    - What was missing?

  • In the email include a link to issue in this Github where teams can write their comment response to the questions.

Guidance on knowing/defining who your user is

Hi @Erioldoesdesign @smithkelseyj, thank you for this comprehensive and clear guide! I am sharing with my team today as a real-world example that user research in the open is possible.

I was struck at this line about knowing your users:

Before testing and synthesis, it’s worth clarifying who your user is. Are you focusing on ‘end users’ (e.g. users that don’t modify or contribute back)? Or are your users also contributors?

Have you all explored or written on how devs can clarify who the user is? I don't have a repo yet but just began a fellowship at the Software Sustainability Institute documenting how devs can measure user experience.

Add a new style for examples

We have a number of examples that currently use the blockquote styling. Example:

Screen Shot 2022-03-18 at 15 29 10

In an effort to use styling to differentiate the types of content so that they are easily distinguishable, we can add a new style for examples.

What are your ideas for this style? Let us know!

Add a new type of callout style

We have several types of content that is using the blockquote style, such as: callout, story, example, quote.

The blockquote looks like this:

Screen Shot 2022-03-18 at 11 18 22

We could add a new callout style with a solid background. This would help the reader distinguish the types of content, making the user experience better and the information more comprehensible.

What a callout could look like:

Callout

Specifications:
Background: #3D3C47
Margins around text: 29px (top/bottom), 26px (right/left)
shadow: #EE72F1, 1px width, offset 12px down/right
Text: #FFFFFF, Fira Code (same as paragraph styling)

Adoptable round 2 - Coaching

Scope of phase

  • At least 1-2 summary reports on coaching/mentorship/guidance provided to privacy and security open source tool teams
  • Submit quarterly subgrant reports
  • At least 1-2 co-branded resources for the open source tool team community

Continue the 'shape together' resource

This resource was started back in Adoptable phase one and was intended to help OSS tool teams with Product management tasks like: Facilitating decision making under governance structures, power structures implicit in decision making, how to build a feature roadmap collaboratively, how design feeds into the strategy of OSS tools etc. etc.

This resource was deemed too 'big' to tackle in phase 1 though it has a draft (locked to Simply Secure staff members) https://docs.google.com/document/d/1GT9GE-B_UCLCFpj661AovSVq8UtGX7JS6SzIQOQlfYo/edit#heading=h.i1bvxzwelvvd

The next tasks on this resource would be:

  • Reading over the existing draft
  • Understanding how it can be made more digestable and bitesized
  • Understanding the best pacing for this kind of advice
  • Reading more PM and Governance books/resources etc.

A designers+ guide to doing user testing in an OSS project

We've covered the 'devs' side of the current resoruces in the Adoptable 'devs guide to' website but we haven't cover the possibility that individuals do not identify or consider themselves as 'devs'

Other types of OSS contributors:

  • Designers
  • Technical Writers / Docs creators
  • QA technical testers
  • Product Managers
  • Community managers / advocates
  • Developer Relations
  • Non-technical Maintainers
  • Power users (of the OSS)

Send out coaching outreach email to tool teams

Sending out comms to existing tool teams with offer for coaching:


Out reach message below

Hi there I’m PERSON NAME from ORG NAME,

We’re reaching back out to you as you were part of the USABLE.tools Adoptable projects initial research conversations where we at Simply Secure investigated what kinds of open resources to create to address the most pressing challenges you face in the open-source field.

If you aren’t aware, we built resources focused around learning and practicing user testing and synthesis skills for developers and non-designers in open source tool teams. You can find the resources and community events we were involved in on the Adoptable projects microsite: A Dev’s guide to…

We’re now onto the next phase of the Adoptable project which is a more hands on approach to collaborating with OSS tools/projects and creating resources from these collaborations. We’d like to offer up to 4 hours of coaching and support to you and your OSS tool/project.

Coaching can mean many things so lets break down what our coaching can be:

  • User Testing preparation support - helping to define who you want to recruit, writing a script for the user test interview and recruiting users for the test sessions.
  • Live User Testing support - helping to interview/lead a user test on your tools
  • User research synthesis session with up to 6 people
  • Helping you decide what design activities are most effective for a problem you have in your OSS project.
  • Helping with making sure User Research is as secure as possible, while also being open if desired.
  • Prioritising issues/tasks/tickets based on design knowledge and user insight and coaching on human centred product management/maintainer processes that include a wide community of contributors.
  • Team design workshops and exercises e.g. Ideation sketching sessions, crazy eights, how might we __, user personas, stakeholder mapping, user journey mapping etc.
  • Open (Source) Design practices - How to set up design documentation, collaborative design systems and files for designers to participate and contribute to
  • Ways to sustain design in the OSS project - Setting up for design contributions including how to onboard designers, offer tasks that are implementable for your tool/project and what to ask for from OSS volunteers
  • Help with knowing what you want from design in the future and making a design plan together

What we expect from you:

  • An idea of what your problems areas are and prioritisation (we can also help with this!)
  • Attendance for meetings and collaborative sessions
  • Written responses and collaborative feedback
  • Be curious, open and responsive - don’t be afraid to ask for help and clarification!
  • Patience - we’ll be coaching multiple projects at once
  • To not expect that we ‘do’ the design work for you, that this is collaborative and about building up your team design capacity and knowledge.
  • Consent and agreement to create any open resources for the wider OSS tool team community as a result of our coaching

What you can expect from us:

  • 4 Hours of our time
  • Open documentation and resources created as we collaborate on the coaching
  • Following through on what you request from the coaching and flexibility should you discover you need to pivot your ask.
  • Attendance, flexibility, honest feedback, understanding and support

When you book can you give us a short, response on what you’d like help with and the best openly accessible places to get information about your OSS tool and your progress/team. If you’re unsure what you’d like to ask for we can organise a short 30 min call to try to help out by asking questions and exploring the current state of your OSS project from a design perspective.

PERSON NAME on behalf of the Adoptable coaching team at Simply Secure

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.