The Product is Docs: Writing technical documentation in a product development group by Christopher Gales & Splunk Documentation Team

Author:Christopher Gales & Splunk Documentation Team [Gales, Christopher]
Language: eng
Format: epub, mobi
Published: 2020-03-04T05:00:00+00:00

Why is this thing odd? Maybe there’s a historical reason or a technical constraint that prevents a feature from being implemented in a sensible way. It might not be wise to document the reason. Describe the essentials accurately and move on.

Can it go in the UI? Users prefer using the product, and recourse to the documentation is a distant second choice for them. If you find yourself documenting an elaborate and manual process, ask whether it can be automated on behalf of the user.

Can the software know it? If you’re telling the user to enter information about the computer they’re using, much of that information is probably available to the software. If you’re warning the user about possible errors, can the software detect those errors and either prevent them or provide error messages? If so, there’s no need to document them.

Download

Copyright Disclaimer:
This site does not store any files on its server. We only index and link to content provided by other sites. Please contact the content providers to delete copyright contents if any and email us, we'll remove relevant links or contents immediately.