Appwrite is a secure open-source backend server provides the core APIs required to build web and mobile applications. Appwrite provides authentication, database, storage, functions, and advanced real-time capabilities.
Appwrite is an open-source project with a fast growing community. It started out as an open-source project a few years ago for the purpose of making software development easier and less complex to give developers a better starting point to build new projects. Our team is actively working with the fast-growing community to make Appwrite better. In this role, you will have the opportunity to work as a designer to help improve our documentation, working closely with our design and developer relations team.
We're looking for a designer to join our design team. This team is responsible for creating landing pages for our website, maintaining internal design assets and presentations, creating illustrations and video content, creating brand identity and guidelines to all existing designs, and improve design in all areas, including all types of documentation and documents.
| Octernship info | Timelines and Stipend |
|---|---|
| Assignment Deadline | 15 May 2023 |
| Octernship Duration | 2 Months |
| Monthly Stipend | $500 USD |
- Experience with Git & GitHub
- Experience with Product Design
To participate, you must be:
- A verified student on Global Campus
- 18 years or older
- Active contributor on GitHub (monthly)
The Appwrite documentation is one of the most important touchpoints that developers come in contact with while interacting with Appwrite: https://appwrite.io/docs. The docs are currently designed in our old design language. We recently launched our open-source design system: Pink Design. We used this design system to create the new Appwrite Console. https://www.youtube.com/watch?v=1Y05yxEM3nU&t=7s We are looking for an Octern that can help us with redesigning our Appwrite docs using this design system. Furthermore, we would love to see you demonstrate your user research abilities, by for example doing a competitive analysis of other docs, interviewing and usability testing, to come up with clever, research-based design solutions.
- Side navigation to navigate within the docs
- SDK and version selection, as can be seen on: https://appwrite.io/docs/client/account
- ‘In this page’ navigation, with anchor links, as can be seen on: https://appwrite.io/docs/client/account
- Main content of the page, with different components like tables, lists, code examples etc.
- Search in the docs
- Ideas on how we can optimize the docs for mobile are welcome. From research, we know that mobile usability could be more optimal. For example, the tables are not working well on mobile.
- We’re in the process of designing a search for the docs - you don’t have to design all the states of the search, but a place for the search needs to be included.
- You don’t have to redesign every single page in the docs, but rather have an example of all the unique layouts and components that are used throughout the docs: table, list, etc.
- Feel free to propose new components for the design system, if you feel like it can’t be solved with existing components.
- Don’t be afraid to get creative, the redesign doesn’t have to be a direct translation of the old design of the docs.
Submit a Figma link with your redesign, with your design rationale included in the Figma file.
- Figma library figma
- npm documentation
- Sample Issue