-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Add how to guide documentation template (#36694)
* Update documentation contributors guide with types - Adds new section that explains how the documentation is organized around types - Updates headings to match sentence case as recommended - Minor text tweaks and updates * Markdown linting * Add how to guide template * Update docs/contributors/documentation/how-to-guide-template.md Co-authored-by: Alex Lende <[email protected]> Co-authored-by: Alex Lende <[email protected]>
- Loading branch information
Showing
2 changed files
with
62 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# How to guide template | ||
|
||
## Overview | ||
|
||
A how to guide walks through a series of steps focused on completing a single task. The guide's goal is not on teaching concepts, but to answer the question "how do I ... ". | ||
|
||
The overview section summarizes the problem and can include context on how and where you might use the solution properly. | ||
|
||
## Before you start | ||
|
||
Include a section on assumptions and prerequisites: | ||
|
||
- Pre-requisite one: WordPress development environment | ||
- Pre-requisite two: familiarity with JavaScript and Gutenberg | ||
- Pre-requisite three: custom block or theme | ||
|
||
Include other important information here, such as known issues or bugs. | ||
|
||
## Step-by-step guide | ||
|
||
The guide should include step-by-step directions. Use code snippets, images, or screenshots to help illustrate each step. Include as many (or as few) steps as needed, try to keep each step short and easy to follow. | ||
|
||
### Step 1: Optional: title | ||
|
||
Brief instructions explaining the first step. | ||
|
||
### Step 2: Optional: title | ||
|
||
Lead-in sentence for an ordered list: | ||
|
||
1. Sub-step A | ||
1. Sub-step B | ||
1. Sub-step C | ||
|
||
### Step 3: Optional: title | ||
|
||
Lead-in sentence explaining the code snippet. For example: | ||
|
||
```shell | ||
npm install | ||
npm run build | ||
``` | ||
|
||
## Troubleshooting | ||
|
||
- What can go wrong? | ||
- What are potential error messages and what to do? | ||
|
||
## Conclusion | ||
|
||
Provide a summary of the steps completed and explain what the user has achieved. You can include links to related articles, more complex examples, or how to learn more on the topic. | ||
|
||
<!-- | ||
This documentation is based on templates from The Good Docs Project. | ||
This comment can be removed in your guide. | ||
--> |