How to Document Features¶

Important

‘Development’ features (i.e., your JIRA stories/roadmap items) != ‘product’ features.

If your product has a specific feature for which documentation would benefit the user, add a feature document to your product docs.

Feature documents can be helpful for features that are especially tricky or complex. In general, try to provide a context (why would someone use this?) and architecture overview (how does it fit into the overall solution/product?).

Example Feature Doc content:

title
=====

General overview

Context (how does this feature fit into the overall solution or product? why does the user need it?)

Describe the feature.
What is it?
What does it do?
How does it benefit the customer?
Be sure to call out any areas that are particularly complex or confusing, or any caveats (e.g., unsupported functionality)

Provide link(s) to any solution documentation that incorporates the feature.