cityofaustin / cityofaustin/techstack
RES Page Review
- Dominant language
- No language data
- Stars
- 11
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Each step in the following checklist means one pass through the text with that step as a lens.
Check the Notes tab and see if there’s anything there you can fix before editing.
**Links and PDFs**
Links on the page go to trustworthy sources (governments, libraries, universities, community partners)
links are written for residents
All links go where they’re intended to go.
All PDFs and other closed documents are necessary for the user
Each PDF has "(PDF, [file size in KB or MB])" directly after the link
Files are not huge (ideally no more than 1 MB/1,000 KB). If huge, compress it and re-upload it. smallpdf.com is one option.
**Related content**
Relevant internal links, events, and locations are all there.
Pages that can have a contact need a contact.
The page is no longer than it needs to be without losing meaning or making it less clear.
Nothing is date-specific or written in a way that’ll be outdated soon. If it makes sense for the topic, edit it to be more evergreen.
**Headers**
No headers as questions (unless there's really no plainer way to say it)
Ensure sentence case
General proof: spelling, grammar, punctuation, capitalization, consistency. Does it conform to our style guide? Wherever that doesn't have an answer, check Chicago (log into the VPN for free access) and go with their answer. Merriam-Webster is our dictionary.
Remove figurative or flowery language that would be difficult to translate.
Remove acronyms (unless it's easier to read and understand with the acronym, which is rare but for example, sometimes a noun is more commonly known by its acronym).
**Remove jargon.**
Define any necessary technical terms.
If it's a simple definition, define it inline, such as: Most of the offenses adjudicated—or legally settled—through the court are committed by…
If it's a definition that needs 2 or more lines, define it in a terminology list at the bottom of the page and inline notification. For example: The court adjudicates (see Terminology below) cases in the downtown area.
**Do a reading level check with Hemingway.**
If it's above 8th grade, do a plain language editing pass.
If it's technical or legal content, get it as low as you can without spending too much time on it.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.