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

Chapter 7 revision based on reading session #26

Merged
merged 6 commits into from
Jan 7, 2025
Merged

Conversation

GBKS
Copy link
Owner

@GBKS GBKS commented Nov 20, 2024

This turned into a much bigger rewrite, including a change of the page name. In our reading session, we did not find the framing of contributing assets very clear. This updated version essentially speaks to publicly documenting your design process and work. Goal is to for design to be transparent, so others can easily catch and keep up and contribute. I think that makes sense within the context of the other pages in the guide.

Something I tried to include is to ensure readers know that super simple documentation is fine for smaller contributions, and then also show how this can scale over time.

The page still feels like a little bit of a patchwork, but I think I need to come back to it and/or feedback from others. So I'm putting this PR out there now for conversation. So what do you think?

⛓️Check the preview⛓️‍💥

This turned into a much bigger rewrite, including a change of the page name. In our reading session, we did not find the framing of contributing assets very clear. This updated version essentially speaks to publicly documenting your design process and work. Goal is to for design to be transparent, so others can easily catch and keep up and contribute.

The page still feels like a little bit of a patchwork, but I think I need to come back to it and/or feedback from others. So I'm putting this PR out there now for conversation. So what do you think?
@GBKS GBKS added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 20, 2024
@GBKS GBKS self-assigned this Nov 20, 2024
Copy link

netlify bot commented Nov 20, 2024

Deploy Preview for opendesign-guide ready!

Name Link
🔨 Latest commit 1c9f179
🔍 Latest deploy log https://app.netlify.com/sites/opendesign-guide/deploys/677d3412c22ecc0008fad1b8
😎 Deploy Preview https://deploy-preview-26--opendesign-guide.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@GBKS GBKS added enhancement New feature or request and removed enhancement New feature or request documentation Improvements or additions to documentation labels Nov 20, 2024
Copy link

@Erioldoesdesign Erioldoesdesign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :shipit:

@UmarSalihu
Copy link

Hey Christoph,

I'd like to take this on.

@GBKS
Copy link
Owner Author

GBKS commented Dec 11, 2024

@UmarSalihu what would you like to take on? If it's reviewing these changes, you are totally welcome to do that (here's a quick how-to video).

@UmarSalihu
Copy link

@GBKS Yeah, it's the review.

Great. I'll watch the video and proceed. If I have any questions or need clarification, I'll reach out to you.
Thanks.

Copy link
Contributor

@paperpsych paperpsych left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if we're supposed to review the chapters like this but here goes something...

preview: design-assets-preview.jpg
---

# Making Design Accessible
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I read the title, I felt the chapter is about making design accessible for people with varying abilities. After reading the chapter, I realized it's about helping people craft designs that are understandable, reusable, and collaborative in the open source context. I'd suggest changing it to something like: Designing for Collaboration !!

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I renamed the page to "Design for Collaboration".


# Making Design Accessible

When we contribute to open source projects, we're doing more than just creating interfaces or graphics – we're sharing work that others can learn from, adapt, and improve upon. This might mean designing a single feature for a small utility app, creating icons for a developer tool, or building a comprehensive design system for a large application. The size of the project doesn't matter as much as the approach: making our work accessible and understandable to others.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When we contribute to open source projects, we're doing more than just creating interfaces or graphics – we're sharing work that others can learn from, adapt, and improve upon. This might mean designing a single feature for a small utility app, creating icons for a developer tool, or building a comprehensive design system for a large application. The size of the project doesn't matter as much as the approach: making our work accessible and understandable to others.
In open source design, you're not just creating interfaces or graphics; you're sharing work that others can learn from, adapt, and build upon. Whether it’s a single feature for a small utility app or a comprehensive design system for a large application, the goal remains the same: to make your design accessible, understandable, and easy to collaborate on for other contributors.

The last sentence in the paragraph felt slightly abrupt. I reframed that line and the paragraph a bit to make it flow a better.


## Starting Simple

Not every project needs extensive documentation or a complex design system. For a small project, you might simply include notes directly in your design files explaining key decisions and usage guidelines.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Not every project needs extensive documentation or a complex design system. For a small project, you might simply include notes directly in your design files explaining key decisions and usage guidelines.
Not every project needs extensive documentation or a complex design system right away. For smaller projects, you can include simple notes directly in your design files to help others understand and use your work effectively.


Not every project needs extensive documentation or a complex design system. For a small project, you might simply include notes directly in your design files explaining key decisions and usage guidelines.

As an example, you might document:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As an example, you might document:
For example, you could document:

As an example, you might document:

- **The Problem:** Explain what issue you were trying to solve with your design.
- **Your Process:** Even if informal, share how you came up with the design, including any research you did.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Your Process:** Even if informal, share how you came up with the design, including any research you did.
- **Your Process:** Share how you approached the problem, including any research or brainstorming notes you have (don’t worry if they’re informal.)

- Modification options
- Attribution requirements

## Growing Your Impact
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Growing Your Impact
## Scaling Your Contributions


## Growing Your Impact

As you become more involved in a project, you might find opportunities to improve its overall design process. This could be as simple as creating templates for future design contributions or as involved as helping establish design guidelines. Let these systems grow naturally based on the project's needs rather than forcing complex processes too early.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As you become more involved in a project, you might find opportunities to improve its overall design process. This could be as simple as creating templates for future design contributions or as involved as helping establish design guidelines. Let these systems grow naturally based on the project's needs rather than forcing complex processes too early.
As you become more involved in a project, you can contribute beyond individual designs by improving the project's overall design process. This doesn’t mean imposing complex systems upfront — but building what’s needed, when it’s needed. Let the project’s needs guide the level of structure you introduce. Simple, lightweight solutions are often more impactful than complex ones.


As you become more involved in a project, you might find opportunities to improve its overall design process. This could be as simple as creating templates for future design contributions or as involved as helping establish design guidelines. Let these systems grow naturally based on the project's needs rather than forcing complex processes too early.

## Conclusion
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For conclusion, the line about "creating work that others can understand, use, and build upon" is mentioned twice - making it redundant.

Also, personal preference, I feel that the conclusions to the chapters should be a reinforcement of the core philosophy of open design principles that a particular chapter expresses or expands upon. If this is not how we're currently writing the conclusions then feel free to disregard the following suggestions :)

So based on that, I'm dividing the conclusion into 03 bullet points. They're pretty similar to what the conclusion says right now !!


## Conclusion

Effective open source design is about creating work that others can understand, use, and build upon. By making your process transparent and your files accessible, you enable true collaboration and collective improvement. Start small – perhaps by better documenting one component or reorganizing one set of files – and expand your approach as you see the benefits of increased clarity and collaboration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Effective open source design is about creating work that others can understand, use, and build upon. By making your process transparent and your files accessible, you enable true collaboration and collective improvement. Start small – perhaps by better documenting one component or reorganizing one set of files – and expand your approach as you see the benefits of increased clarity and collaboration.
Open-source design is about more than creating something beautiful or functional — it’s about enabling others to collaborate, learn, and build upon your work. This philosophy drives the open-source ecosystem, and it’s just as crucial in design.


Effective open source design is about creating work that others can understand, use, and build upon. By making your process transparent and your files accessible, you enable true collaboration and collective improvement. Start small – perhaps by better documenting one component or reorganizing one set of files – and expand your approach as you see the benefits of increased clarity and collaboration.

The most successful open source designs aren't just well-crafted – they're well-documented, easily understood, and ready for others to build upon. By sharing not just what we create but how and why we create it, we strengthen the entire open source design ecosystem.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The most successful open source designs aren't just well-crafted – they're well-documented, easily understood, and ready for others to build upon. By sharing not just what we create but how and why we create it, we strengthen the entire open source design ecosystem.
Key Takeaways
- Design with Collaboration in Mind
Every component, icon, or system you create is a building block for someone else. By making your work accessible and understandable, you’re opening doors for others to contribute and innovate.
- Start Small, Scale Thoughtfully
You don’t need to create a complex system on day one. Start by documenting small components or organizing files clearly. As the project grows, your contributions can evolve to meet new challenges.
- Embrace Collective Growth
The most impactful open designs aren’t just great in isolation — they’re tools for shared success. By sharing your thought process, decisions, and learnings, you’re building a foundation for others to create, adapt, and improve upon.

Are these too cheesy? 😅

GBKS and others added 5 commits January 7, 2025 14:43
Co-authored-by: paperpsych <149538435+paperpsych@users.noreply.github.com>
Can't commit any proposed changes by Paperpsych on Github, and Github is stuck on checking whether merging can be done automatically. Maybe another commit will snap it out of it's problems.
@GBKS
Copy link
Owner Author

GBKS commented Jan 7, 2025

Thank you for the review @paperpsych. I accepted almost all of your suggestions. Not sure why they still show up as unresolved on this page, but the changes are in the committed files.

I'll push this update live as they are a nice big update. Anyone is totally welcome to do another read-through of the live page then and open another PR with any changes they'd like to see.

@GBKS GBKS merged commit eee6f38 into main Jan 7, 2025
4 checks passed
@GBKS GBKS deleted the feature/chapter-7-revision branch January 7, 2025 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants