What you’ll need
What you’ll need
What it is
What happened
Lead with the event, who it affects, and when it happened.
Why it matters
Explain what changes for people building or using the technology.
Sources
Link to the original release, documentation, or other primary material.
Define the concept in a sentence and explain the problem it solves.
How it works
Walk through the main parts or steps in plain language.
A practical example
Show what the reader would see in a realistic project.
List the hardware, software, or prior knowledge readers will need.
Steps
Describe the first action and what the reader should see.
Expected result
Show how to verify the completed project.
Troubleshooting
Explain the most likely failure and how to check it.
List the hardware, software, or prior knowledge readers will need.
Steps
Describe the first action and what the reader should see.
Expected result
Show how to verify the completed project.
Troubleshooting
Explain the most likely failure and how to check it.