Developers
Tutorials and examples
Tutorials should lead to a visible result with exact prerequisites, commands, expected output and recovery steps.
What you’ll do
Tutorials should lead to a visible result with exact prerequisites, commands, expected output and recovery steps. Examples should be small enough to understand and explicit about the architecture, ABI and release they target.
Before you begin
A good example becomes a test fixture and a starting point for real work rather than a one-time demo.
Steps
1. Reproducible
Pin toolchain, image, source revision and target; provide complete commands.
2. Explanatory
Show why capability-aware code differs and what warning, fault or boundary the reader should observe.
3. Maintainable
Test tutorials against releases, state the last verified date and provide an issue route for breakage.
Check your result
Examples often omit production error handling, hardening and performance considerations. Treat them as teaching material, not drop-in product code.
Record the architecture, platform, ABI, release, source revision and complete commands. A second developer should be able to reproduce the result.