Rewrite feature help for a reader starting from zero
Technical vocabulary can conceal a simple action. Keep implementation details out of instructions unless they help the user make a decision.
Start here
This example uses the sample details below. Replace them with your own facts before applying the instructions.
- User needs a prompt and selected ratio; download follows successful generation.
Start with the facts
User needs a prompt and selected ratio; download follows successful generation. Keep the source notes beside the draft. Decide what the reader needs to understand or do, and mark any fact you still need to confirm.
Spot the problem
The wording or action to avoid is: “Initialize inference parameters and persist resultant artifacts.” Technical vocabulary can conceal a simple action. Keep implementation details out of instructions unless they help the user make a decision.
Make the correction
Describe the image, choose a ratio and select Generate. When the request finishes, review the result and download it.
Check before using the result
Ask a new reader to identify the first action and the point at which a file becomes available.
Worked example and reusable input
Use the stated inputs to reproduce checked local outputs. Replace sample facts when applying a brief to your own work.
TASK Rewrite feature help for a reader starting from zero SAMPLE INPUT — replace with your actual facts User needs a prompt and selected ratio; download follows successful generation. AVOID Initialize inference parameters and persist resultant artifacts. CORRECTED APPROACH Describe the image, choose a ratio and select Generate. When the request finishes, review the result and download it. ACCEPTANCE CHECK Ask a new reader to identify the first action and the point at which a file becomes available.
Key takeaways
- Technical vocabulary can conceal a simple action. Keep implementation details out of instructions unless they help the user make a decision.
- Ask a new reader to identify the first action and the point at which a file becomes available.