Technical writing: Difference between revisions
Jump to navigation
Jump to search
m
→Software documentation checklist
| Line 23: | Line 23: | ||
** Evaluate if examples are straightforward and detailed, including explanations of fields and sourcing of specific values. | ** Evaluate if examples are straightforward and detailed, including explanations of fields and sourcing of specific values. | ||
Example for reference: How to get the source of | Example for reference: How to get the source of id and hash values | ||
<pre> | <pre> | ||
{" | {"id":"123","hash":"xxxxxx"} | ||
</pre> | </pre> | ||