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 24, 2024
1 parent b24a0ca commit 7a8f433
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
# AccessibilityDocumentation(https://vodgroup.github.io/AccessibilityDocumentation/documentation/accessibilitydocumentation/)
# [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** 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**.
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**.

Generally the project is dedicated to those who use the mentioned instrumentality in their work: **software developers** and **product designers**.

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.
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.

## Why make it a website?
Websites is an exemplary **cross-platform** solution. Having resources available on the Net widens its **accessibility**.

## 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 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).

## What can I find in this repository?

Expand All @@ -21,19 +22,22 @@ To focus on the implementation 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 overwiev for implenting accessibility in the 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**:
- **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;
- **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).


## Sponsored by VoiceOver 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

Code source: https://github.com/VODGroup/VoiceOverDesigner

![Screenshot of VoiceOver Designer](https://rubanov.dev/voice-over-designer/images/HeaderLight.png)

0 comments on commit 7a8f433

Please sign in to comment.