themiked/wordpress-documentation-style-guide

Style Guide for @WordPress documentation. Google Season of Docs 2020 project for @tacitonic.

WordPress Documentation Style Guide

The WordPress Documentation Style Guide is one of Google Season of Docs' projects for 2020.
⚠️ The Style Guide is currently under development.

• Technical writer: Atharva Dhekne (@tacitonic)
• Mentors: Felipe Elia (@felipeelia) and Milana Cap (@zzap)

Proposed elements/components in the style guide

Status	Description
🔄	In progress
✔️	Completed
❌	Discarded
⚠️	Needs changes

Style guide introduction (New section) 🔄

Component	Status
WordPress style guide	🔄 (⚠️ while publishing)
Style guide highlights
Other resources	🔄
Changelog	✔️

Document guidelines 🔄

Component	Status
Accessibility	✔️ (⚠️ while publishing)
Document structure	✔️ (⚠️ while publishing)
Changes to the guide (New component)	✔️ (⚠️ while publishing)
Encoding	✔️
External sources	✔️ (⚠️ while publishing)
Facts	✔️
Fonts	✔️ (Moved to Formatting)
Global audience	✔️
Inclusivity	✔️ (⚠️ while publishing)
Legality, licensing, trademarks	✔️ (Moved to Formatting)
Multi-platform accessibility	✔️
Non-ambiguous, no excessive claims	✔️
Page layout	✔️
Political correctness	✔️
Protocols	✔️
Security	✔️
Sentence structure	✔️
Succinct writing	✔️
Tone and style	⚠️
Unbiased	✔️

Language and grammar ✔️

Component	Status
Abbreviations and acronyms	✔️ (⚠️ while publishing)
Affirmation and negation	❌
Articles	✔️ (⚠️ while publishing)
Capitalization	✔️ (⚠️ while publishing)
Clause	✔️
Contractions (New component)	✔️ (⚠️ while publishing)
Direct/indirect speech	✔️
Genders	✔️ (Moved to Pronouns)
Glossary	(Moved to Word Usage Dictionary)
Grammatical person	✔️
Nouns	✔️ (⚠️ while publishing)
Plurals (New component)	✔️ (⚠️ while publishing)
Possessives (New component)	✔️
Prefixes and suffixes	✔️ (⚠️ while publishing)
Prepositions	✔️
Pronouns	✔️ (⚠️ while publishing)
Referencing	✔️ (Moved to Formatting)
Slang and jargon	✔️ (Moved to Word Choice)
Spellings	✔️ (Moved to Word Choice)
Technical terms	✔️ (Moved to Word Choice)
Tense	✔️ (⚠️ while publishing)
Verbs	✔️ (⚠️ while publishing)
Voice	✔️
Word choice (New component)	✔️ (⚠️ while publishing)

Punctuation ✔️

Component	Status
Apostrophes	✔️ (⚠️ while publishing)
Colons	✔️ (⚠️ while publishing)
Commas	✔️ (⚠️ while publishing)
Dashes (split from Hyphens)	✔️ (⚠️ while publishing)
Ellipses	✔️
Exclamation points	✔️ (⚠️ while publishing)
Hyphens	✔️ (⚠️ while publishing)
Parentheses	✔️ (⚠️ while publishing)
Periods	✔️ (⚠️ while publishing)
Question marks	✔️
Quotation marks (split from Apostrophes)	✔️
Semicolons (split from Colons)	✔️
Slashes	✔️ (⚠️ while publishing)

Formatting ✔️

Component	Status
Abstracts, introduction, prefaces	❌
Brand names, product names	✔️
Captions	✔️ (Moved to Media)
Code snippets, code blocks	✔️ (Moved to Code)
Currencies	✔️ (Moved to Numbers)
Date and time, time zones, places	✔️ (⚠️ while publishing)
Examples and scenarios (New component)	✔️ (⚠️ while publishing)
Filenames	✔️ (⚠️ while publishing)
Footnotes	✔️ (⚠️ while publishing)
Headings and titles	✔️ (⚠️ while publishing)
Highlighting (Bold, italics, underline, strikethrough, quotation)	✔️ (Moved to Text formatting)
Indentation	❌
Index	❌
Key terms (New component)	✔️
Links and URLs	✔️ (Moved to Linking)
Lists, bullet points, numbering	✔️ (⚠️ while publishing)
Media (Images, videos) and illustrations	✔️ (⚠️ while publishing)
Notices (Notes, warnings, tips)	✔️ (⚠️ while publishing)
Numbers	✔️ (⚠️ while publishing)
Obsolete content (New component)	✔️ (⚠️ while publishing)
Phone numbers	✔️ (⚠️ while publishing)
Polyglots, translation, language scripts	✔️
Referencing	✔️ (Moved to Linking)
Spacing	✔️ (Moved to Text formatting)
Tables	✔️ (⚠️ while publishing)
Text formatting	✔️ (⚠️ while publishing)
Trademarks, copyrights, patents, citations	✔️ (⚠️ while publishing)
Tutorials and procedures	✔️ (⚠️ while publishing)
Typography and fonts	✔️ (Moved to Text formatting)
UI elements	✔️ (Moved to User interface)
Units of measurement	✔️ (⚠️ while publishing)
Words as words (New component)	✔️ (⚠️ while publishing)

Linking (New section) 🔄

Component	Status
Cross-references	✔️ (⚠️ while publishing)
External links	🔄
Heading links	✔️
Image links	✔️
Link text	✔️ (⚠️ while publishing)

User interface (Moved to Developer content) ✔️

Component	Status
Activities	✔️
Buttons	✔️
Code snippets, code blocks	✔️
Command line interface	✔️
Dialogs	✔️
Menus and dropdowns	✔️
Pop-ups and alerts	✔️
Tabs	✔️
Terminology	✔️
UI elements	✔️
Windows	✔️

Developer content ✔️

Component	Status
Code in text (New component)	✔️ (⚠️ while publishing)
Code examples	✔️ (⚠️ while publishing)
Coding standards (New component)	✔️
Command-line syntax	✔️ (⚠️ while publishing)
CSS	✔️ (Moved to Coding standards)
HTML	✔️ (Moved to Coding standards)
JS	✔️ (Moved to Coding standards)
Markdown	✔️ (Moved to Coding standards)
MySQL	❌
PHP	✔️ (Moved to Coding standards)
Placeholder formatting (New component)	✔️ (⚠️ while publishing)
Syntax	✔️
Terminology	✔️
UI elements	✔️ (⚠️ while publishing)
XML	❌

Word usage dictionary/Glossary 🔄

Component	Status
A-Z Word list	🔄

Future components

Component	Status
Media > Videos