{"id":14954781,"url":"https://github.com/wordpress/wordpress-documentation-style-guide","last_synced_at":"2025-12-29T18:04:22.425Z","repository":{"id":43117611,"uuid":"293793350","full_name":"WordPress/WordPress-Documentation-Style-Guide","owner":"WordPress","description":"Style Guide for WordPress documentation.","archived":false,"fork":false,"pushed_at":"2024-02-16T13:54:27.000Z","size":2763,"stargazers_count":49,"open_issues_count":10,"forks_count":23,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-01-29T08:11:21.287Z","etag":null,"topics":["documentation","google","google-season-of-docs","gsod","gsod-2020","season-of-docs","style-guide","wordpress","wordpress-standards"],"latest_commit_sha":null,"homepage":"https://make.wordpress.org/docs/style-guide/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WordPress.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-08T11:45:18.000Z","updated_at":"2025-01-25T03:48:22.000Z","dependencies_parsed_at":"2024-09-29T06:17:35.388Z","dependency_job_id":null,"html_url":"https://github.com/WordPress/WordPress-Documentation-Style-Guide","commit_stats":{"total_commits":2405,"total_committers":8,"mean_commits":300.625,"dds":"0.033264033264033266","last_synced_commit":"a7ed44faf5bac5b9af22bbccf4579c0f2539de0d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WordPress%2FWordPress-Documentation-Style-Guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WordPress%2FWordPress-Documentation-Style-Guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WordPress%2FWordPress-Documentation-Style-Guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WordPress%2FWordPress-Documentation-Style-Guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WordPress","download_url":"https://codeload.github.com/WordPress/WordPress-Documentation-Style-Guide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237080120,"owners_count":19252280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","google","google-season-of-docs","gsod","gsod-2020","season-of-docs","style-guide","wordpress","wordpress-standards"],"created_at":"2024-09-24T13:09:25.457Z","updated_at":"2025-10-19T07:30:46.737Z","avatar_url":"https://github.com/WordPress.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# WordPress Documentation Style Guide\n\nThe 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.\n\n- Technical writer: Atharva Dhekne ([@tacitonic](https://github.com/tacitonic))\n- Mentors: Felipe Elia ([@felipeelia](https://github.com/felipeelia)) and Milana Cap ([@zzap](https://github.com/zzap))\n\nQuick links:\n- [WordPress Documentation Style Guide](https://make.wordpress.org/docs/style-guide/)\n- [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)\n- [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/)\n\n## Proposed elements/components in the style guide\n\n| Status | Description |\n|---------|-------------|\n| 🔄      | In progress |\n| ✔️      | Completed   |\n| ❌      | Discarded   |\n| ⚠️      | Needs changes |\n\n### Style guide introduction (New section) ✔️\n\n| Component                          | Status  |\n|------------------------------------|---------|\n| WordPress style guide              |   ✔️   |\n| Style guide highlights             |   ✔️   |\n| Other resources                    |   ✔️   |\n| Changelog                          |   ✔️   |\n\n### Document guidelines ✔️\n\n| Component                          | Status  |\n|------------------------------------|---------|\n| Accessibility                      |   ✔️   |\n| Document structure                 |   ✔️   |\n| Changes to the guide (New component)|  ✔️   |\n| Encoding                           |   ✔️   |\n| External sources                   |   ✔️   |\n| Facts                              |   ✔️   |\n| Fonts                              |   ✔️ (Moved to Formatting)   |\n| Global audience                    |   ✔️   |\n| Inclusivity                        |   ✔️   |\n| Legality, licensing, trademarks    |   ✔️ (Moved to Formatting)   |\n| Multi-platform accessibility       |   ✔️   |\n| Non-ambiguous, no excessive claims |   ✔️   |\n| Page layout                        |   ✔️   |\n| Political correctness              |   ✔️   |\n| Protocols                          |   ✔️   |\n| Security                           |   ✔️   |\n| Sentence structure                 |   ✔️   |\n| Succinct writing                   |   ✔️   |\n| Tone and style                     |   ✔️   |\n| Unbiased                           |   ✔️   |\n\n### Language and grammar ✔️\n\n| Component                                         | Status |\n|---------------------------------------------------|--------|\n| Abbreviations and acronyms                        |   ✔️   |\n| Affirmation and negation                          |   ❌   |\n| Articles                                          |   ✔️   |\n| Capitalization                                    |   ✔️   |\n| Clause                                            |   ✔️   |\n| Contractions (New component)                      |   ✔️   |\n| Direct/indirect speech                            |   ✔️   |\n| Genders                                           |   ✔️ (Moved to Pronouns)   |\n| Glossary                                          |   (Moved to Word Usage Dictionary)   |\n| Grammatical person                                |   ✔️   |\n| Nouns                                             |   ✔️   |\n| Plurals (New component)                           |   ✔️   |\n| Possessives (New component)                       |   ✔️   |\n| Prefixes and suffixes                             |   ✔️   |\n| Prepositions                                      |   ✔️   |\n| Pronouns                                          |   ✔️   |\n| Referencing                                       |   ✔️ (Moved to Formatting)   |\n| Slang and jargon                                  |   ✔️ (Moved to Word Choice)   |\n| Spellings                                         |   ✔️ (Moved to Word Choice)   |\n| Technical terms                                   |   ✔️ (Moved to Word Choice)   |\n| Tense                                             |   ✔️   |\n| Verbs                                             |   ✔️   |\n| Voice                                             |   ✔️   |\n| Word choice (New component)                       |   ✔️   |\n\n### Punctuation ✔️\n\n| Component                    | Status |\n|------------------------------|--------|\n| Apostrophes                  |   ✔️   |\n| Colons                       |   ✔️   |\n| Commas                       |   ✔️   |\n| Dashes (split from Hyphens)  |   ✔️   |\n| Ellipses                     |   ✔️   |\n| Exclamation points           |   ✔️   |\n| Hyphens                      |   ✔️   |\n| Parentheses                  |   ✔️   |\n| Periods                      |   ✔️   |\n| Question marks               |   ✔️   |\n| Quotation marks (split from Apostrophes)|   ✔️   |\n| Semicolons (split from Colons)|   ✔️   |\n| Slashes                      |   ✔️   |\n\n### Formatting ✔️\n\n| Component                                                         | Status |\n|-------------------------------------------------------------------|--------|\n| Abstracts, introduction, prefaces                                 |   ❌   |\n| Brand names, product names                                        |   ✔️   |\n| Captions                                                          |   ✔️ (Moved to Media)   |\n| Code snippets, code blocks                                        |   ✔️ (Moved to Code)   |\n| Currencies                                                        |   ✔️ (Moved to Numbers)   |\n| Date and time, time zones, places                                 |   ✔️   |\n| Examples and scenarios (New component)                            |   ✔️   |\n| Filenames                                                         |   ✔️   |\n| Footnotes                                                         |   ✔️   |\n| Headings and titles                                               |   ✔️   |\n| Highlighting (Bold, italics, underline, strikethrough, quotation) |   ✔️ (Moved to Text formatting)   |\n| Indentation                                                       |   ❌   |\n| Index                                                             |   ❌   |\n| Key terms (New component)                                         |   ✔️   |\n| Links and URLs                                                    |   ✔️ (Moved to Linking)   |\n| Lists, bullet points, numbering                                   |   ✔️   |\n| Media (Images, videos) and illustrations                          |   ✔️   |\n| Notices (Notes, warnings, tips)                                   |   ✔️   |\n| Numbers                                                           |   ✔️   |\n| Obsolete content (New component)                                  |   ✔️   |\n| Phone numbers                                                     |   ✔️   |\n| Polyglots, translation, language scripts                          |   ✔️   |\n| Referencing                                                       |   ✔️ (Moved to Linking)   |\n| Spacing                                                           |   ✔️ (Moved to Text formatting)   |\n| Tables                                                            |   ✔️   |\n| Text formatting                                                   |   ✔️   |\n| Trademarks, copyrights, patents, citations                        |   ✔️   |\n| Tutorials and procedures                                          |   ✔️   |\n| Typography and fonts                                              |   ✔️ (Moved to Text formatting)   |\n| UI elements                                                       |   ✔️ (Moved to User interface)   |\n| Units of measurement                                              |   ✔️   |\n| Words as words (New component)                                    |   ✔️   |\n\n### Linking (New section) ✔️\n\n| Component                  | Status |\n|----------------------------|--------|\n| Cross-references           |   ✔️   |\n| External links             |   ✔️   |\n| Heading links              |   ✔️   |\n| Image links                |   ✔️   |\n| Link text                  |   ✔️   |\n\n### User interface (Moved to Developer content) ✔️\n\n| Component                  | Status |\n|----------------------------|--------|\n| Activities                 |   ✔️   |\n| Buttons                    |   ✔️   |\n| Code snippets, code blocks |   ✔️   |\n| Command line interface     |   ✔️   |\n| Dialogs                    |   ✔️   |\n| Menus and dropdowns        |   ✔️   |\n| Pop-ups and alerts         |   ✔️   |\n| Tabs                       |   ✔️   |\n| Terminology                |   ✔️   |\n| UI elements                |   ✔️   |\n| Windows                    |   ✔️   |\n\n### Developer content ✔️\n\n| Component   | Status |\n|-------------|--------|\n| Code in text (New component) |   ✔️   |\n| Code examples |   ✔️   |\n| Coding standards (New component) |   ✔️   |\n| Command-line syntax |   ✔️   |\n| CSS         |   ✔️ (Moved to Coding standards)   |\n| HTML        |   ✔️ (Moved to Coding standards)   |\n| JS          |   ✔️ (Moved to Coding standards)   |\n| Markdown    |   ✔️ (Moved to Coding standards)   |\n| MySQL       |   ❌   |\n| PHP         |   ✔️ (Moved to Coding standards)   |\n| Placeholder formatting (New component) |   ✔️   |\n| Syntax      |   ✔️   |\n| Terminology |   ✔️   |\n| UI elements |   ✔️   |\n| XML         |   ❌   |\n\n### Word list and usage dictionary ✔️\n\n| Component | Status |\n|-----------|--------|\n| Numbers |   ✔️   |\n| Symbols |   ✔️   |\n| A |   ✔️   |\n| B |   ✔️   |\n| C |   ✔️   |\n| D |   ✔️   |\n| E |   ✔️   |\n| F |   ✔️   |\n| G |   ✔️   |\n| H |   ✔️   |\n| I |   ✔️   |\n| J |   ✔️   |\n| K |   ✔️   |\n| L |   ✔️   |\n| M |   ✔️   |\n| N |   ✔️   |\n| O |   ✔️   |\n| P |   ✔️   |\n| Q |   ✔️   |\n| R |   ✔️   |\n| S |   ✔️   |\n| T |   ✔️   |\n| U |   ✔️   |\n| V |   ✔️   |\n| W |   ✔️   |\n| X |   ✔️   |\n| Y |   ✔️   |\n| Z |   ✔️   |\n\n### Future components\n\n| Component | Status |\n|-----------|--------|\n| Media \u003e Videos |        |\n| API reference documentation |        |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwordpress%2Fwordpress-documentation-style-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwordpress%2Fwordpress-documentation-style-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwordpress%2Fwordpress-documentation-style-guide/lists"}