How-to guides are much like recipes in a recipe book. Write how-to docs to solve specific problems quickly, sometimes copy-pastable. Think of how-to guides as pre-emptive StackOverflow-like problems.
How-to guides are much like recipes in a recipe book. Write how-to docs to solve specific problems quickly, sometimes copy-pastable. Think of how-to guides as pre-emptive StackOverflow-like problems.
# For Readers
## For Readers
[comment]:<>(This is a good place to mention any places for someone to start looking in. Highlight specific docs with high value or we identify readers commonly want to see)
[comment]:<>(This is a good place to mention any places for someone to start looking in. Highlight specific docs with high value or we identify readers commonly want to see)
Use the table of contents on the left to start browsing guides.
Use the table of contents on the left to start browsing guides.
# For Authors
## For Authors
Before you start writing a new How-To guide. Make sure what you are writing belongs here. These are similar to getting-started guides, in that they explain to users how to perform some valuable tasks with the software, but distinct in that they:
Before you start writing a new How-To guide. Make sure what you are writing belongs here. These are similar to getting-started guides, in that they explain to users how to perform some valuable tasks with the software, but distinct in that they: