TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
A short document (note) showing an example of the application of the product
to the solution of a specific problem -- often showing off one of the
product's strong points or showing how to work around one of its lacks.
>What usually goes into one?
Diagrams. Procedures. Words.
>Do they usually contain strictly hardware information ...
Frequently. For example, an app note for a microprocessor might describe how
to select the minimum memory latency to assure zero-wait-state operation at
given processor clock speeds.
> ...or do they sometimes include software information?
Yes. An app note for a microprocessor might describe a typical sequence of
code for the processor to execute when the power comes on.
>Are there guidelines for app notes?
They should focus on a specific problem or task. They should spell out the
steps the reader must follow to solve the problem using the product. They
should be short.
>What makes them different from reference manual information?
That depends on the reference manual. Few manuals focus on solving specific
problems. ...RM
