Skip to content

TEST.md

Latest commit

 

History

History
50 lines (34 loc) · 1.91 KB

TEST.md

File metadata and controls

50 lines (34 loc) · 1.91 KB

Test File for Linting

Background

This is a test .MD file for VA.gov Vale Plain Language Linting rules.

Contractions

The following words should raise warnings:

Please use it's it is it has

Would've Could've Should've

Conversational Tone

When referring to VA, use the first-person pronoun (we, us, our). When referring to Veterans, service members, family member, use the second person pronoun (you, your)

Sentence-case capitalization

We use sentence-case capitalization for most content, including page titles, headings, subheadings, buttons, and text links unless a word is a proper noun.

(Examples of proper nouns: “VA.gov,” the word “Veteran" or "Veterans," official VA program names, state names, names of federal agencies, days of the week, months, book titles)

Time

--Write out times, using a.m. and p.m. with periods: for example, 9:00 a.m. NOT: 9 am or 9 a.m. --Spell out noon and midnight. Don’t use 12:00 p.m. or 12:00 a.m.

Specific style and formatting of commonly used words on VA.gov

--service member: this should be lowercase and two words. Don't write as Servicemember --active duty: Hyphenate when it modifies a noun and don’t capitalize. (for example, active-duty service member --federal: don't capitalize for generic usage (for example, federal agency) --GI: this shouldn't have any periods. Don't write as G.I. --PO Box: this shouldn't have any periods. Don't write as P.O. Box --service connected: Don't hyphenate unless it appears before a noun (for example, service-connected disability) --sign in, sign out: We use sign in/sign out on VA.gov. Don’t use log in, log out, login ID, or sign on.