External documentation #
External documentation refers to the written materials that are created for users of a software system. External documentation can be divided into several categories, including:
End-user documentation
This type of documentation is intended for the end users of a software system, who are typically non-technical individuals. End-user documentation includes user manuals, help files, and online tutorials that explain how to use the software and troubleshoot common issues.
Enterprise user documentation
This type of documentation is similar to end-user documentation, but is targeted at enterprise users who are responsible for managing and maintaining the software within their organization. Enterprise user documentation may include information on how to install and configure the software, how to perform maintenance tasks, and how to troubleshoot issues.
API documentation
This type of document is relevant for some products and is aimed at developers who extend the product or interact with it.
Just-in-time documentation
Just-in-time documentation is documentation that is created on an as-needed basis, rather than being included in the software itself. It is often used in situations where the software is highly complex or changes frequently, and traditional documentation may not be sufficient. Just-in-time documentation may include online resources such as FAQs, forums, and wikis, which users can access when they need help with specific tasks or issues.
