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

Update Readme #8

Merged
merged 7 commits into from
Jan 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
# [AccessibilityDocumentation](https://vodgroup.github.io/AccessibilityDocumentation/documentation/accessibilitydocumentation/)

## - What is this?
At the moment this project is a vague prototype of **wrapping the already-existing documentation of [Accessibility features available in iOS SDK](https://developer.apple.com/design/human-interface-guidelines/accessibility)** in a way **to make it easier to research** available in a form of a **web-resource**. In other words our goal is to find a solution for **making plain documentation more entertaining and requiring nothing more than a web-browser**. Call it an ***education resource***.
## What is this?
At the moment this project is a vague prototype of **wrapping the already-existing documentation of [Accessibility features available in iOS SDK](https://developer.apple.com/design/human-interface-guidelines/accessibility)** in a way **to make it easier to research** available in a form of a **web-resource**. In other words our goal is to find a solution for **making plain documentation more entertaining and requiring nothing more than a web-browser**. Call it an ***educational resource***.

Generally the project is dedicated to those who use the mentioned *toolkit* in their *work*: **developers**, **designers**, **researchers**. Nevertheless the content is planned that way so **one could learn Accessibility from its very *basics***. It is just not about raising *awareness*, at least for now.

## - How is it supposed to work?
## How is it supposed to work?

Currently our goal is to try out variable methods of documentation wrapping by implementing various **interactive solutions**, such as **step-by-step guides**, wide range of **media types** used and **[VoiceOver Designer](https://github.com/VODGroup/VoiceOverDesigner)** app prototype integration in order to find the most efficient *educational models*.

The *interactivity* is implemented by heavy relying on **[DocC](https://developer.apple.com/documentation/docc), which is a native rich documentation solution for [Swift projects](https://www.swift.org/packages)**. It uses **[Markdown](https://apple.github.io/swift-markdown/documentation/markdown)** as its *formatting language*.

Since it is only a *prototype*, having the resource hosted by **[GitHub Pages](https://pages.github.com)** seems to us a great option **to allow anyone to contribute to the project**. **GitHub Pages simply turns a GitHub repository into a *website*, which plays along *open-source development* fittingly**.

## - Why make it a website?
*Websites* is an exemplary **cross-platform solution**. Having resources available on the Net widens its **availability** - one has to have nothing more than a web browser and an Internet connection to **access the resource**.
## Why make it a website?
*Websites* is an exemplary **cross-platform solution**. Having resources available on the Net widens its **availability** one has to have nothing more than a web browser and an Internet connection to **access the resource**.

## - What can I find in this repository specifically?
## What can I find in this repository specifically?

### Tutorials
To focus on the implementation of assistive technologies.
- Real-life cases in screens and scenarios examples involving usage of assistive technologies.
- Step-by-step guides how to apply Accessibility Features.
- **Real-life cases** in screens and scenarios involving usage of *assistive technologies*.
- **Step-by-step guides** how to apply **Accessibility Features**.

### Articles
To study the concepts.
- Accessibility Properties in Code: How to Use Them. A brief overview of implenting accessibility in apps
- Accessibility Features Explained: How People Use Assistive Technology. A thorough description of the concepts and its technological implementations in order to provide a better understanding of how it all works.
- Accessibility Properties in Code: How to Use Them. A brief overview of **implenting accessibility in apps**.
- Accessibility Features Explained: How People Use Assistive Technology. A thorough **description of the concepts** and its technological implementations in order **to provide a better understanding** of how it all works.

## - Can I contribute to the project?
## Can I contribute to the project?
Yes, **everyone is welcome to influence the project**, especially considering a non-commercial nature of it. It can be done by **comitting *ideas* and *fixes* to this repository** or **straightforwardly reaching someone from the team**. A few examples of doing this:
- **describe a problem** or **discuss on the topic** in [Issues](https://github.com/VODGroup/AccessibilityDocumentation/issues);
- **describe a problem** or **discuss on the topic** in **[Issues](https://github.com/VODGroup/AccessibilityDocumentation/issues)**;
- **propose a change** by creating a *pull request* to this repository;
<img width="876" alt="Screenshot 2024-01-25 at 09 58 20" src="https://github.com/VODGroup/AccessibilityDocumentation/assets/94866528/fccf206f-c2a6-4698-a3fe-a2352861c3f2">
- **get in contact with one of the [responsible contributors](https://github.com/VODGroup/AccessibilityDocumentation/graphs/contributors)** by using the *credential information* they provide;
<img width="875" alt="Screenshot 2024-01-26 at 11 16 58" src="https://github.com/VODGroup/AccessibilityDocumentation/assets/94866528/e43ef14c-6649-45f6-ae57-d915ee0900a7">
- **write an article** from tasks listed in [Projects](https://github.com/orgs/VODGroup/projects/5/views/1).
- **write an article** from *tasks* listed in **[Projects](https://github.com/orgs/VODGroup/projects/5/views/1)**.
<img width="844" alt="Screenshot 2024-01-25 at 10 11 13" src="https://github.com/VODGroup/AccessibilityDocumentation/assets/94866528/6a713fc9-5ab1-44cf-b821-4a76a2954d89">

## Sponsored by [VoiceOver Designer](https://rubanov.dev/voice-over-designer)
Expand Down
Loading