Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wordpress/wordpress-documentation-style-guide
Style Guide for WordPress documentation.
https://github.com/wordpress/wordpress-documentation-style-guide
documentation google google-season-of-docs gsod gsod-2020 season-of-docs style-guide wordpress wordpress-standards
Last synced: 4 months ago
JSON representation
Style Guide for WordPress documentation.
- Host: GitHub
- URL: https://github.com/wordpress/wordpress-documentation-style-guide
- Owner: WordPress
- License: gpl-2.0
- Created: 2020-09-08T11:45:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-16T13:54:27.000Z (11 months ago)
- Last Synced: 2024-10-07T09:38:56.727Z (4 months ago)
- Topics: documentation, google, google-season-of-docs, gsod, gsod-2020, season-of-docs, style-guide, wordpress, wordpress-standards
- Homepage: https://make.wordpress.org/docs/style-guide/
- Size: 2.64 MB
- Stars: 49
- Watchers: 16
- Forks: 24
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# WordPress Documentation Style Guide
The WordPress Documentation Style Guide is one of [Google Season of Docs' projects](https://developers.google.com/season-of-docs/docs/2020/participants/project-wordpress-tacitonic) for 2020.
- Technical writer: Atharva Dhekne ([@tacitonic](https://github.com/tacitonic))
- Mentors: Felipe Elia ([@felipeelia](https://github.com/felipeelia)) and Milana Cap ([@zzap](https://github.com/zzap))
Quick links:
- [WordPress Documentation Style Guide](https://make.wordpress.org/docs/style-guide/)
- [Google Season of Docs original project proposal for tacitonic (Atharva Dhekne) – Google Developers](https://developers.google.com/season-of-docs/docs/2020/participants/project-wordpress-tacitonic)
- [WordPress Documentation Style Guide – Google Season of Docs 2020 Project Report](https://make.wordpress.org/docs/2021/03/07/wordpress-documentation-style-guide-google-season-of-docs-2020-project-report-tacitonic/)
## 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 | ✔️ |
| Style guide highlights | ✔️ |
| Other resources | ✔️ |
| Changelog | ✔️ |
### Document guidelines ✔️
| Component | Status |
|------------------------------------|---------|
| Accessibility | ✔️ |
| Document structure | ✔️ |
| Changes to the guide (New component)| ✔️ |
| Encoding | ✔️ |
| External sources | ✔️ |
| Facts | ✔️ |
| Fonts | ✔️ (Moved to Formatting) |
| Global audience | ✔️ |
| Inclusivity | ✔️ |
| 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 | ✔️ |
| Affirmation and negation | ❌ |
| Articles | ✔️ |
| Capitalization | ✔️ |
| Clause | ✔️ |
| Contractions (New component) | ✔️ |
| Direct/indirect speech | ✔️ |
| Genders | ✔️ (Moved to Pronouns) |
| Glossary | (Moved to Word Usage Dictionary) |
| Grammatical person | ✔️ |
| Nouns | ✔️ |
| Plurals (New component) | ✔️ |
| Possessives (New component) | ✔️ |
| Prefixes and suffixes | ✔️ |
| Prepositions | ✔️ |
| Pronouns | ✔️ |
| Referencing | ✔️ (Moved to Formatting) |
| Slang and jargon | ✔️ (Moved to Word Choice) |
| Spellings | ✔️ (Moved to Word Choice) |
| Technical terms | ✔️ (Moved to Word Choice) |
| Tense | ✔️ |
| Verbs | ✔️ |
| Voice | ✔️ |
| Word choice (New component) | ✔️ |
### Punctuation ✔️
| Component | Status |
|------------------------------|--------|
| Apostrophes | ✔️ |
| Colons | ✔️ |
| Commas | ✔️ |
| Dashes (split from Hyphens) | ✔️ |
| Ellipses | ✔️ |
| Exclamation points | ✔️ |
| Hyphens | ✔️ |
| Parentheses | ✔️ |
| Periods | ✔️ |
| Question marks | ✔️ |
| Quotation marks (split from Apostrophes)| ✔️ |
| Semicolons (split from Colons)| ✔️ |
| Slashes | ✔️ |
### 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 | ✔️ |
| Examples and scenarios (New component) | ✔️ |
| Filenames | ✔️ |
| Footnotes | ✔️ |
| Headings and titles | ✔️ |
| 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 | ✔️ |
| Media (Images, videos) and illustrations | ✔️ |
| Notices (Notes, warnings, tips) | ✔️ |
| Numbers | ✔️ |
| Obsolete content (New component) | ✔️ |
| Phone numbers | ✔️ |
| Polyglots, translation, language scripts | ✔️ |
| Referencing | ✔️ (Moved to Linking) |
| Spacing | ✔️ (Moved to Text formatting) |
| Tables | ✔️ |
| Text formatting | ✔️ |
| Trademarks, copyrights, patents, citations | ✔️ |
| Tutorials and procedures | ✔️ |
| Typography and fonts | ✔️ (Moved to Text formatting) |
| UI elements | ✔️ (Moved to User interface) |
| Units of measurement | ✔️ |
| Words as words (New component) | ✔️ |
### Linking (New section) ✔️
| Component | Status |
|----------------------------|--------|
| Cross-references | ✔️ |
| External links | ✔️ |
| Heading links | ✔️ |
| Image links | ✔️ |
| Link text | ✔️ |
### 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) | ✔️ |
| Code examples | ✔️ |
| Coding standards (New component) | ✔️ |
| Command-line syntax | ✔️ |
| 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) | ✔️ |
| Syntax | ✔️ |
| Terminology | ✔️ |
| UI elements | ✔️ |
| XML | ❌ |
### Word list and usage dictionary ✔️
| Component | Status |
|-----------|--------|
| Numbers | ✔️ |
| Symbols | ✔️ |
| A | ✔️ |
| B | ✔️ |
| C | ✔️ |
| D | ✔️ |
| E | ✔️ |
| F | ✔️ |
| G | ✔️ |
| H | ✔️ |
| I | ✔️ |
| J | ✔️ |
| K | ✔️ |
| L | ✔️ |
| M | ✔️ |
| N | ✔️ |
| O | ✔️ |
| P | ✔️ |
| Q | ✔️ |
| R | ✔️ |
| S | ✔️ |
| T | ✔️ |
| U | ✔️ |
| V | ✔️ |
| W | ✔️ |
| X | ✔️ |
| Y | ✔️ |
| Z | ✔️ |
### Future components
| Component | Status |
|-----------|--------|
| Media > Videos | |
| API reference documentation | |