There are numerous approaches to writing documentation, but one of the fundamental distinctions a doc writer must make is whether the resulting doc’s goal is to:
- Describe “features” of a product, software, solution, etc., and how to use these features, or
- Explain what actions to take in order to perform a task to achieve a specific goal
Both approaches have valid uses, but there are areas or use cases where one is better than the other. It can also depend on who is writing the documentation and who is the intended audience.
[Category: Open Source]