Skip to content

[Feature] Add section on accessible documents to the Writing section of the guide. #403

@ZoeRichter

Description

@ZoeRichter

Describe the feature you'd like.

Here is the writing section of the guide that I'm talking about. I'd like to have some general advice and tips on making your written work more accessible added to the guides somewhere, and after some discussion I think this is a pretty good spot for it.

Description of what you want to happen.

For a past skill share, I made this presentation going over some general tips on accessibility. At bare minimum, this presentation (or at least, these slides) should be moved into their own separate presentation (so that the general meeting notes aren't attached to it) and a title slide added. Then, this presentation can be linked to the guide, alongside some text introducing the new section/the presentation.

However, I think there is also room for this to be expanded upon. Either the slides could be added to or updated with more information and tips, or (on top of this?) the content could be moved out of the presentation entirely, and re-written to look nice on the webpage directly (still linking to the various resources in the presentation). I would generally prefer the information be added to the guide directly, so that we don't have to worry about the link expiring/permissions changing/files moving/etc.

As a final note - it probably wouldn't hurt to specifically touch on colorblindness-friendly color options (slide 1 in the skill share) in this section, but Nathan Ryan's relatively recent guide on plots also has some of this information included, so you may not need to be quite as thorough.

Multiple people could work on this issue - in order to keep git branches and commits organized, I would recommend using the sub-issue feature when you start work on a specific part of it, that you can close as you go. General discussion can be done in comments here in the parent issue, too. Also remember that you can save a PR as a draft before you make it official!

How can this issue be closed?

This issue can be closed with a PR that adds a sub-section to the writing guide as detailed above.

Metadata

Metadata

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions