Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
crescentheaded authored Jan 26, 2024
1 parent 03b5616 commit c74733d
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# [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**.
## - 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***.

Generally the project is dedicated to those who use the mentioned instrumentality in their work: **software developers** and **product designers**.
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.

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 in order to find the most efficient educational methods.
## - How is it supposed to work?

## Why make it a website?
Websites is an exemplary **cross-platform** solution. Having resources available on the Net widens its **accessibility**.
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*.

## How does it function?
The project itself is a [Swift Package](https://www.swift.org/packages/) that contains a [DocC](https://developer.apple.com/documentation/docc) file out of which the website is built.
The deployement is implemented by [GitHub Pages](https://pages.github.com).
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*.

## What can I find in this repository?
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**.

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

### Tutorials
To focus on the implementation of assistive technologies.
Expand All @@ -26,16 +28,18 @@ 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.

## Can I contribute to the project?
Yes, **everyone is welcome to influence the project**. It can be done by **comitting *ideas* and *fixes* to this repository**:
## - 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);
- **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).
<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
## Sponsored by [VoiceOver Designer](https://rubanov.dev/voice-over-designer)
**VoiceOver Designer** is a macOS application that allows to **design and prototype accessibility features over a *screenshot of an app***.

More about the app: https://rubanov.dev/voice-over-designer
Expand Down

0 comments on commit c74733d

Please sign in to comment.